{"openapi":"3.0.0","info":{"description":"Developer platform","version":[{"name":"2026-03-10","value":"X-GitHub-Api-Version"}]},"servers":[{"description":"Developer platform","url":"https://api.apirails.com/github"}],"paths":{"/":{"get":{"tags":["Meta"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/meta/meta#github-api-root","api_endpoint":"https://api.github.com/"},"summary":"GitHub API Root","description":"Get Hypermedia links to resources accessible in GitHub's REST API","security":[{"bearerAuth":[]}]}},"/advisories":{"get":{"tags":["Security Advisories"],"parameters":[{"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","example":"","items":{"type":"string","enum":["reviewed","malware","unreviewed"]}}},{"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.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`","schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"cve_id","in":"query","description":"If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.","schema":{"type":"string","example":""}},{"name":"cwes","in":"query","description":"If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"ecosystem","in":"query","description":"The package's language or package management ecosystem.","schema":{"type":"string","example":"","items":{"type":"string","enum":["rubygems","npm","pip","maven","nuget","composer","go","rust","erlang","actions","pub","other","swift"]}}},{"name":"epss_percentage","in":"query","description":"If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.","schema":{"type":"string","example":""}},{"name":"epss_percentile","in":"query","description":"If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.","schema":{"type":"string","example":""}},{"name":"ghsa_id","in":"query","description":"If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.","schema":{"type":"string","example":""}},{"name":"is_withdrawn","in":"query","description":"Whether to only return advisories that have been withdrawn.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"modified","in":"query","description":"If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"published","in":"query","description":"If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"","schema":{"type":"string","example":""}},{"name":"severity","in":"query","description":"If specified, only advisories with these severities will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["unknown","low","medium","high","critical"]}}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["updated","published","epss_percentage","epss_percentile"]}}},{"name":"updated","in":"query","description":"If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories","api_endpoint":"https://api.github.com/advisories"},"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.\n\nBy 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/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"","security":[{"bearerAuth":[]}]}},"/advisories/{ghsa_id}":{"get":{"tags":["Security Advisories"],"parameters":[{"name":"ghsa_id","in":"path","description":"The GHSA (GitHub Security Advisory) identifier of the advisory.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory","api_endpoint":"https://api.github.com/advisories/{ghsa_id}"},"summary":"Get a global security advisory","description":"Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.","security":[{"bearerAuth":[]}]}},"/agents/repos/{owner}/{repo}/tasks":{"get":{"tags":["Agent Tasks"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"creator_id","in":"query","description":"Filter tasks by creator user ID. Accepts one or more user IDs.","schema":{"type":"array","example":""}},{"name":"direction","in":"query","description":"The direction to sort results. Can be `asc` or `desc`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"is_archived","in":"query","description":"Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"The page number of the results to fetch.","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 100).","schema":{"type":"number","example":""}},{"name":"since","in":"query","description":"Only show tasks updated at or after this time (ISO 8601 timestamp)","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The field to sort results by. Can be `updated_at` or `created_at`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["updated_at","created_at"]}}},{"name":"state","in":"query","description":"Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository","api_endpoint":"https://api.github.com/agents/repos/{owner}/{repo}/tasks"},"summary":"List tasks for repository","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n\n**Fine-grained access tokens for \"List tasks for repository\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n","security":[{"bearerAuth":[]}]},"post":{"tags":["Agent Tasks"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agent-tasks/agent-tasks#start-a-task","api_endpoint":"https://api.github.com/agents/repos/{owner}/{repo}/tasks"},"summary":"Start a task","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nStarts a new Copilot cloud agent task for a repository.\n\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.\n\n**Fine-grained access tokens for \"Start a task\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read and write)\n\nGitHub App installation access tokens are not supported for this endpoint.\n","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"base_ref":{"type":"string","description":"Base ref for new branch/PR"},"create_pull_request":{"type":"boolean","description":"Whether to create a PR.","enum":[true,false]},"custom_agent":{"type":"string","description":"Optional identifier for a custom agent to use for this task. Use the custom agent's filename without the extension - for example, for a `.github/agents/performance-optimizer.agent.md` custom agent, use `performance-optimizer`."},"head_ref":{"type":"string","description":"Head ref for existing branch/PR. If provided with `base_ref`, the agent looks up open PR context for `head_ref` targeting `base_ref` and commits to `head_ref` instead of creating a new branch."},"model":{"type":"string","description":"The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`"},"prompt":{"type":"string","description":"The user's prompt for the agent","required":true}}},"example":{"base_ref":"","create_pull_request":"","custom_agent":"","head_ref":"","model":"","prompt":""}}}}}},"/agents/repos/{owner}/{repo}/tasks/{task_id}":{"get":{"tags":["Agent Tasks"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"task_id","in":"path","description":"The unique identifier of the task.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo","api_endpoint":"https://api.github.com/agents/repos/{owner}/{repo}/tasks/{task_id}"},"summary":"Get a task by repo","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n\n**Fine-grained access tokens for \"Get a task by repo\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n","security":[{"bearerAuth":[]}]}},"/agents/tasks":{"get":{"tags":["Agent Tasks"],"parameters":[{"name":"direction","in":"query","description":"The direction to sort results. Can be `asc` or `desc`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"is_archived","in":"query","description":"Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"The page number of the results to fetch.","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 100).","schema":{"type":"number","example":""}},{"name":"since","in":"query","description":"Only show tasks updated at or after this time (ISO 8601 timestamp)","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The field to sort results by. Can be `updated_at` or `created_at`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["updated_at","created_at"]}}},{"name":"state","in":"query","description":"Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks","api_endpoint":"https://api.github.com/agents/tasks"},"summary":"List tasks","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n\n**Fine-grained access tokens for \"List tasks\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n","security":[{"bearerAuth":[]}]}},"/agents/tasks/{task_id}":{"get":{"tags":["Agent Tasks"],"parameters":[{"name":"task_id","in":"path","description":"The unique identifier of the task.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id","api_endpoint":"https://api.github.com/agents/tasks/{task_id}"},"summary":"Get a task by ID","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n\n**Fine-grained access tokens for \"Get a task by ID\"**\n\nThis endpoint works with the following fine-grained token types:\n\n* [GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)\n* [Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)\n\nThe fine-grained token must have the following permission set:\n\n* \"Agent tasks\" repository permissions (read)\n\nGitHub App installation access tokens are not supported for this endpoint.\n","security":[{"bearerAuth":[]}]}},"/app":{"get":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#get-the-authenticated-app","api_endpoint":"https://api.github.com/app"},"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/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]}},"/app-manifests/{code}/conversions":{"post":{"tags":["Apps"],"parameters":[{"name":"code","in":"path","description":"code","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest","api_endpoint":"https://api.github.com/app-manifests/{code}/conversions"},"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/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`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/app/hook/config":{"get":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app","api_endpoint":"https://api.github.com/app/hook/config"},"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).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app","api_endpoint":"https://api.github.com/app/hook/config"},"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).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content_type":{"type":"string","description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."},"insecure_ssl":{"type":"string","description":"insecure_ssl"},"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/webhooks/event-payloads/#delivery-headers)."},"url":{"type":"string","description":"The URL to which the payloads will be delivered."}}},"example":{"content_type":"","insecure_ssl":"","secret":"","url":""}}}}}},"/app/hook/deliveries":{"get":{"tags":["Apps"],"parameters":[{"name":"cursor","in":"query","description":"Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"redelivery","in":"query","description":"redelivery","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"status","in":"query","description":"Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).","schema":{"type":"string","example":"","items":{"type":"string","enum":["success","failure"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook","api_endpoint":"https://api.github.com/app/hook/deliveries"},"summary":"List deliveries for an app webhook","description":"Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]}},"/app/hook/deliveries/{delivery_id}":{"get":{"tags":["Apps"],"parameters":[{"name":"delivery_id","in":"path","description":"delivery_id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook","api_endpoint":"https://api.github.com/app/hook/deliveries/{delivery_id}"},"summary":"Get a delivery for an app webhook","description":"Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]}},"/app/hook/deliveries/{delivery_id}/attempts":{"post":{"tags":["Apps"],"parameters":[{"name":"delivery_id","in":"path","description":"delivery_id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook","api_endpoint":"https://api.github.com/app/hook/deliveries/{delivery_id}/attempts"},"summary":"Redeliver a delivery for an app webhook","description":"Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/app/installation-requests":{"get":{"tags":["Apps"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app","api_endpoint":"https://api.github.com/app/installation-requests"},"summary":"List installation requests for the authenticated app","description":"Lists all the pending installation requests for the authenticated GitHub App.","security":[{"bearerAuth":[]}]}},"/app/installations":{"get":{"tags":["Apps"],"parameters":[{"name":"outdated","in":"query","description":"outdated","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app","api_endpoint":"https://api.github.com/app/installations"},"summary":"List installations for the authenticated app","description":"The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]}},"/app/installations/{installation_id}":{"get":{"tags":["Apps"],"parameters":[{"name":"installation_id","in":"path","description":"The unique identifier of the installation.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app","api_endpoint":"https://api.github.com/app/installations/{installation_id}"},"summary":"Get an installation for the authenticated app","description":"Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Apps"],"parameters":[{"name":"installation_id","in":"path","description":"The unique identifier of the installation.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app","api_endpoint":"https://api.github.com/app/installations/{installation_id}"},"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/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/app/installations/{installation_id}/access_tokens":{"post":{"tags":["Apps"],"parameters":[{"name":"installation_id","in":"path","description":"The unique identifier of the installation.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app","api_endpoint":"https://api.github.com/app/installations/{installation_id}/access_tokens"},"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 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.\n\n> [!NOTE]\n> Starting April 27, 2026, GitHub began a staged rollout of a stateless format (`ghs_APPID_JWT`) to all newly minted GitHub App installation tokens, making them more performant and improving the reliability of our API surface. If your application expects or relies on installation tokens being exactly 40 characters long, it may not handle this new token format correctly. You can now validate your apps and workflows using a temporary request header that lets you enable the token format on demand. For more information about the temporary header, see [the GitHub blog](https://github.blog/changelog/2026-05-15-github-app-installation-tokens-per-request-override-header).\n\nOptionally, 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.\n\nOptionally, 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.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"permissions":{"type":"object","description":"The permissions granted to the fine-grained 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"]},"artifact_metadata":{"type":"string","description":"The level of permission to grant the access token to create and retrieve build artifact metadata records.","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"]},"code_quality":{"type":"string","description":"The level of permission to grant the access token to view and manage code quality data.","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"]},"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"]},"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"]},"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"]},"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"]},"environments":{"type":"string","description":"The level of permission to grant the access token for managing repository environments.","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"]},"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"]},"members":{"type":"string","description":"The level of permission to grant the access token for organization teams and members.","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"]},"organization_administration":{"type":"string","description":"The level of permission to grant the access token to manage access to an organization.","enum":["read","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_copilot_agent_settings":{"type":"string","description":"The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.","enum":["read","write"]},"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":["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_custom_roles":{"type":"string","description":"The level of permission to grant the access token for custom repository roles management.","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_packages":{"type":"string","description":"The level of permission to grant the access token for organization packages published to GitHub Packages.","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_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_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_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"]},"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"]},"profile":{"type":"string","description":"The level of permission to grant the access token to manage the profile settings belonging to a user.","enum":["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"]},"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"]},"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"]}}},"repositories":{"type":"array","description":"List of repository names that the token should have access to","items":{"type":"string"}},"repository_ids":{"type":"array","description":"List of repository IDs that the token should have access to","items":{"type":"number"}}}},"example":{"permissions":{},"repositories":[],"repository_ids":[]}}}}}},"/app/installations/{installation_id}/suspended":{"put":{"tags":["Apps"],"parameters":[{"name":"installation_id","in":"path","description":"The unique identifier of the installation.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#suspend-an-app-installation","api_endpoint":"https://api.github.com/app/installations/{installation_id}/suspended"},"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 API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Apps"],"parameters":[{"name":"installation_id","in":"path","description":"The unique identifier of the installation.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation","api_endpoint":"https://api.github.com/app/installations/{installation_id}/suspended"},"summary":"Unsuspend an app installation","description":"Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/apps/{app_slug}":{"get":{"tags":["Apps"],"parameters":[{"name":"app_slug","in":"path","description":"app_slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#get-an-app","api_endpoint":"https://api.github.com/apps/{app_slug}"},"summary":"Get an app","description":"> [!NOTE]\n> 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`).","security":[{"bearerAuth":[]}]}},"/assignments/{assignment_id}":{"get":{"tags":["Classroom"],"parameters":[{"name":"assignment_id","in":"path","description":"The unique identifier of the classroom assignment.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/classroom/classroom#closed---get-an-assignment","api_endpoint":"https://api.github.com/assignments/{assignment_id}"},"summary":"Closed - Get an assignment","description":"> [!WARNING]\n> **Closed notice:** This operation is no longer available as of August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).","security":[{"bearerAuth":[]}]}},"/assignments/{assignment_id}/accepted_assignments":{"get":{"tags":["Classroom"],"parameters":[{"name":"assignment_id","in":"path","description":"The unique identifier of the classroom assignment.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/classroom/classroom#closed---list-accepted-assignments-for-an-assignment","api_endpoint":"https://api.github.com/assignments/{assignment_id}/accepted_assignments"},"summary":"Closed - List accepted assignments for an assignment","description":"> [!WARNING]\n> **Closed notice:** This operation is no longer available as of August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).","security":[{"bearerAuth":[]}]}},"/assignments/{assignment_id}/grades":{"get":{"tags":["Classroom"],"parameters":[{"name":"assignment_id","in":"path","description":"The unique identifier of the classroom assignment.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/classroom/classroom#closed---get-assignment-grades","api_endpoint":"https://api.github.com/assignments/{assignment_id}/grades"},"summary":"Closed - Get assignment grades","description":"> [!WARNING]\n> **Closed notice:** This operation is no longer available as of August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).","security":[{"bearerAuth":[]}]}},"/classrooms":{"get":{"tags":["Classroom"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/classroom/classroom#closed---list-classrooms","api_endpoint":"https://api.github.com/classrooms"},"summary":"Closed - List classrooms","description":"> [!WARNING]\n> **Closed notice:** This operation is no longer available as of August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).","security":[{"bearerAuth":[]}]}},"/classrooms/{classroom_id}":{"get":{"tags":["Classroom"],"parameters":[{"name":"classroom_id","in":"path","description":"The unique identifier of the classroom.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/classroom/classroom#closed---get-a-classroom","api_endpoint":"https://api.github.com/classrooms/{classroom_id}"},"summary":"Closed - Get a classroom","description":"> [!WARNING]\n> **Closed notice:** This operation is no longer available as of August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).","security":[{"bearerAuth":[]}]}},"/classrooms/{classroom_id}/assignments":{"get":{"tags":["Classroom"],"parameters":[{"name":"classroom_id","in":"path","description":"The unique identifier of the classroom.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/classroom/classroom#closed---list-assignments-for-a-classroom","api_endpoint":"https://api.github.com/classrooms/{classroom_id}/assignments"},"summary":"Closed - List assignments for a classroom","description":"> [!WARNING]\n> **Closed notice:** This operation is no longer available as of August 28, 2026.\n> For more information, see the [GitHub Classroom sunset notice](https://gh.io/classroom-sunset).","security":[{"bearerAuth":[]}]}},"/codes_of_conduct":{"get":{"tags":["Codes Of Conduct"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct","api_endpoint":"https://api.github.com/codes_of_conduct"},"summary":"Get all codes of conduct","description":"Returns array of all GitHub's codes of conduct.","security":[{"bearerAuth":[]}]}},"/codes_of_conduct/{key}":{"get":{"tags":["Codes Of Conduct"],"parameters":[{"name":"key","in":"path","description":"key","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct","api_endpoint":"https://api.github.com/codes_of_conduct/{key}"},"summary":"Get a code of conduct","description":"Returns information about the specified GitHub code of conduct.","security":[{"bearerAuth":[]}]}},"/credentials/revoke":{"post":{"tags":["Credentials"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials","api_endpoint":"https://api.github.com/credentials/revoke"},"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.\n\nThis endpoint currently accepts the following credential types:\n- Personal access tokens (classic) (`ghp_`)\n- Fine-grained personal access tokens (`github_pat_`)\n- OAuth app access tokens (`gho_`)\n- User-to-server tokens from GitHub Apps (`ghu_`)\n- Refresh tokens from GitHub Apps (`ghr_`)\n\n\nRevoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.\n\nTo prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.\n\n> [!NOTE]\n> Any authenticated requests will return a 403.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"credentials":{"type":"array","description":"A list of credentials to be revoked, up to 1000 per request.","required":true,"items":{"type":"string"}}}},"example":{"credentials":[]}}}}}},"/emojis":{"get":{"tags":["Emojis"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/emojis/emojis#get-emojis","api_endpoint":"https://api.github.com/emojis"},"summary":"Get emojis","description":"Lists all the emojis available to use on GitHub.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/actions/cache/retention-limit":{"get":{"tags":["Actions"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/actions/cache/retention-limit"},"summary":"Get GitHub Actions cache retention limit for an enterprise","description":"Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/actions/cache/retention-limit"},"summary":"Set GitHub Actions cache retention limit for an enterprise","description":"Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_cache_retention_days":{"type":"number","description":"For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained."}}},"example":{"max_cache_retention_days":""}}}}}},"/enterprises/{enterprise}/actions/cache/storage-limit":{"get":{"tags":["Actions"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/actions/cache/storage-limit"},"summary":"Get GitHub Actions cache storage limit for an enterprise","description":"Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/actions/cache/storage-limit"},"summary":"Set GitHub Actions cache storage limit for an enterprise","description":"Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_cache_size_gb":{"type":"number","description":"For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes."}}},"example":{"max_cache_size_gb":""}}}}}},"/enterprises/{enterprise}/actions/oidc/customization/properties/repo":{"get":{"tags":["OIDC"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/actions/oidc/customization/properties/repo"},"summary":"List OIDC custom property inclusions for an enterprise","description":"Lists the repository custom properties that are included in the OIDC token for repository actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["OIDC"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/actions/oidc/customization/properties/repo"},"summary":"Create an OIDC custom property inclusion for an enterprise","description":"Adds a repository custom property to be included in the OIDC token for repository actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_property_name":{"type":"string","description":"The name of the custom property to include in the OIDC token","required":true}}},"example":{"custom_property_name":""}}}}}},"/enterprises/{enterprise}/actions/oidc/customization/properties/repo/{custom_property_name}":{"delete":{"tags":["OIDC"],"parameters":[{"name":"custom_property_name","in":"path","description":"The name of the custom property to remove from OIDC token inclusion","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/actions/oidc/customization/properties/repo/{custom_property_name}"},"summary":"Delete an OIDC custom property inclusion for an enterprise","description":"Removes a repository custom property from being included in the OIDC token for repository actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/enterprises/{enterprise}/code-security/configurations":{"get":{"tags":["Code Security"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations"},"summary":"Get code security configurations for an enterprise","description":"Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Code Security"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations"},"summary":"Create a code security configuration for an enterprise","description":"Creates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"advanced_security":{"type":"string","description":"The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `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.\n","enum":["enabled","disabled","code_security","secret_protection"]},"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","properties":{"runner_label":{"type":"string","description":"The label of the runner to use for code scanning default setup when runner_type is 'labeled'."},"runner_type":{"type":"string","description":"Whether to use labeled runners or standard GitHub runners.","enum":["standard","labeled","not_set"]}}},"code_scanning_delegated_alert_dismissal":{"type":"string","description":"The enablement status of code scanning delegated alert dismissal","enum":["enabled","disabled","not_set"]},"code_scanning_options":{"type":"object","description":"Security Configuration feature options for code scanning","properties":{"allow_advanced":{"type":"boolean","description":"Whether to allow repos which use advanced setup","enum":[true,false]}}},"code_security":{"type":"string","description":"The enablement status of GitHub Code Security features.","enum":["enabled","disabled","not_set"]},"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"]},"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.","enum":[true,false]}}},"description":{"type":"string","description":"A description of the code security configuration"},"enforcement":{"type":"string","description":"The enforcement status for a security configuration","enum":["enforced","unenforced"]},"name":{"type":"string","description":"The name of the code security configuration. Must be unique within the enterprise.","required":true},"private_vulnerability_reporting":{"type":"string","description":"The enablement status of private vulnerability reporting","enum":["enabled","disabled","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"]},"secret_scanning_delegated_alert_dismissal":{"type":"string","description":"The enablement status of secret scanning delegated alert dismissal","enum":["enabled","disabled","not_set"]},"secret_scanning_extended_metadata":{"type":"string","description":"The enablement status of secret scanning extended metadata","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_non_provider_patterns":{"type":"string","description":"The enablement status of secret scanning non provider patterns","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"]}}},"example":{"advanced_security":"","code_scanning_default_setup":"","code_scanning_default_setup_options":{},"code_scanning_delegated_alert_dismissal":"","code_scanning_options":{},"code_security":"","dependabot_alerts":"","dependabot_security_updates":"","dependency_graph":"","dependency_graph_autosubmit_action":"","dependency_graph_autosubmit_action_options":{},"description":"","enforcement":"","name":"","private_vulnerability_reporting":"","secret_protection":"","secret_scanning":"","secret_scanning_delegated_alert_dismissal":"","secret_scanning_extended_metadata":"","secret_scanning_generic_secrets":"","secret_scanning_non_provider_patterns":"","secret_scanning_push_protection":"","secret_scanning_validity_checks":""}}}}}},"/enterprises/{enterprise}/code-security/configurations/defaults":{"get":{"tags":["Code Security"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations/defaults"},"summary":"Get default code security configurations for an enterprise","description":"Lists the default code security configurations for an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/code-security/configurations/{configuration_id}":{"get":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations/{configuration_id}"},"summary":"Retrieve a code security configuration of an enterprise","description":"Gets a code security configuration available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations/{configuration_id}"},"summary":"Update a custom code security configuration for an enterprise","description":"Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"advanced_security":{"type":"string","description":"The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `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.\n","enum":["enabled","disabled","code_security","secret_protection"]},"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","properties":{"runner_label":{"type":"string","description":"The label of the runner to use for code scanning default setup when runner_type is 'labeled'."},"runner_type":{"type":"string","description":"Whether to use labeled runners or standard GitHub runners.","enum":["standard","labeled","not_set"]}}},"code_scanning_delegated_alert_dismissal":{"type":"string","description":"The enablement status of code scanning delegated alert dismissal","enum":["enabled","disabled","not_set"]},"code_scanning_options":{"type":"object","description":"Security Configuration feature options for code scanning","properties":{"allow_advanced":{"type":"boolean","description":"Whether to allow repos which use advanced setup","enum":[true,false]}}},"code_security":{"type":"string","description":"The enablement status of GitHub Code Security features.","enum":["enabled","disabled","not_set"]},"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"]},"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.","enum":[true,false]}}},"description":{"type":"string","description":"A description of the code security configuration"},"enforcement":{"type":"string","description":"The enforcement status for a security configuration","enum":["enforced","unenforced"]},"name":{"type":"string","description":"The name of the code security configuration. Must be unique across the enterprise."},"private_vulnerability_reporting":{"type":"string","description":"The enablement status of private vulnerability reporting","enum":["enabled","disabled","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"]},"secret_scanning_delegated_alert_dismissal":{"type":"string","description":"The enablement status of secret scanning delegated alert dismissal","enum":["enabled","disabled","not_set"]},"secret_scanning_extended_metadata":{"type":"string","description":"The enablement status of secret scanning extended metadata","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_non_provider_patterns":{"type":"string","description":"The enablement status of secret scanning non-provider patterns","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"]}}},"example":{"advanced_security":"","code_scanning_default_setup":"","code_scanning_default_setup_options":{},"code_scanning_delegated_alert_dismissal":"","code_scanning_options":{},"code_security":"","dependabot_alerts":"","dependabot_security_updates":"","dependency_graph":"","dependency_graph_autosubmit_action":"","dependency_graph_autosubmit_action_options":{},"description":"","enforcement":"","name":"","private_vulnerability_reporting":"","secret_protection":"","secret_scanning":"","secret_scanning_delegated_alert_dismissal":"","secret_scanning_extended_metadata":"","secret_scanning_generic_secrets":"","secret_scanning_non_provider_patterns":"","secret_scanning_push_protection":"","secret_scanning_validity_checks":""}}}}},"delete":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations/{configuration_id}"},"summary":"Delete a code security configuration for an enterprise","description":"Deletes a code security configuration from an enterprise.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach":{"post":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach"},"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.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"scope":{"type":"string","description":"The type of repositories to attach the configuration to.","required":true,"enum":["all","all_without_configurations"]}}},"example":{"scope":""}}}}}},"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults":{"put":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults"},"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.\n\nThis 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.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"]}}},"example":{"default_for_new_repos":""}}}}}},"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories":{"get":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration","api_endpoint":"https://api.github.com/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories"},"summary":"Get repositories associated with an enterprise code security configuration","description":"Lists the repositories associated with an enterprise code security configuration in an organization.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day":{"get":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"The day to request data for, in `YYYY-MM-DD` format.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day"},"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.\n\nThe 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.\n\nThe 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.\n\nEnterprise 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.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest":{"get":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest"},"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.\n\nThe 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.\n\nThe 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.\n\nEnterprise 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.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/copilot/metrics/reports/repos-1-day":{"get":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"The day to request data for, in `YYYY-MM-DD` format.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-repository-report-for-a-specific-day","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/metrics/reports/repos-1-day"},"summary":"Get Copilot enterprise repository report for a specific day","description":"Use this endpoint to retrieve download links for the Copilot enterprise repository report for a specific day. The report provides per-repository pull request metrics for Copilot across the enterprise, with one entry per repository.\n\nThe report contains repository-level pull request activity for the specified day, including the Copilot Coding Agent (CCA) and Copilot Code Review (CCR) breakdowns. Only repositories that had activity on the specified day are included. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe 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.\n\nEnterprise 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.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day":{"get":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"The day to request data for, in `YYYY-MM-DD` format.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day"},"summary":"Get Copilot enterprise user-teams report for a specific day","description":"Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe 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.\n\nEnterprise 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.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/copilot/metrics/reports/users-1-day":{"get":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"The day to request data for, in `YYYY-MM-DD` format.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/metrics/reports/users-1-day"},"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.\n\nThe 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.\n\nReports 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.\n\nEnterprise 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.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest":{"get":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest"},"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.\n\nThe 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.\n\nReports 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.\n\nEnterprise 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.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/copilot/policies/coding_agent":{"put":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/policies/coding_agent"},"summary":"Set the coding agent policy for an enterprise","description":"Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"policy_state":{"type":"string","description":"The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.","required":true,"enum":["enabled_for_all_orgs","disabled_for_all_orgs","enabled_for_selected_orgs","configured_by_org_admins"]}}},"example":{"policy_state":""}}}}}},"/enterprises/{enterprise}/copilot/policies/coding_agent/organizations":{"post":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/policies/coding_agent/organizations"},"summary":"Add organizations to the enterprise coding agent policy","description":"Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_properties":{"type":"array","description":"List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.","items":{"type":"object","properties":{"property_name":{"type":"string","description":"The name of the custom property to filter by.","required":true},"values":{"type":"array","description":"The values of the custom property to match.","required":true}}}},"organizations":{"type":"array","description":"List of organization logins within the enterprise to enable Copilot cloud agent for.","items":{"type":"string"}}}},"example":{"custom_properties":[],"organizations":[]}}}}},"delete":{"tags":["Copilot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#remove-organizations-from-the-enterprise-coding-agent-policy","api_endpoint":"https://api.github.com/enterprises/{enterprise}/copilot/policies/coding_agent/organizations"},"summary":"Remove organizations from the enterprise coding agent policy","description":"Disables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can remove organizations from the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_properties":{"type":"array","description":"List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.","items":{"type":"object","properties":{"property_name":{"type":"string","description":"The name of the custom property to filter by.","required":true},"values":{"type":"array","description":"The values of the custom property to match.","required":true}}}},"organizations":{"type":"array","description":"List of organization logins within the enterprise to disable Copilot cloud agent for.","items":{"type":"string"}}}},"example":{"custom_properties":[],"organizations":[]}}}}}},"/enterprises/{enterprise}/dependabot/alerts":{"get":{"tags":["Dependabot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"assignee","in":"query","description":"Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"classification","in":"query","description":"A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"ecosystem","in":"query","description":"A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`","schema":{"type":"string","example":""}},{"name":"epss_percentage","in":"query","description":"CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.","schema":{"type":"string","example":""}},{"name":"first","in":"query","description":"**Deprecated**","schema":{"type":"number","example":""}},{"name":"has","in":"query","description":"Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.","schema":{"type":"string","example":""}},{"name":"last","in":"query","description":"**Deprecated**","schema":{"type":"number","example":""}},{"name":"package","in":"query","description":"A comma-separated list of package names. If specified, only alerts for these packages will be returned.","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"relationship","in":"query","description":"A comma-separated list of relationships of the vulnerable dependency to your project. If specified, only alerts with these relationships will be returned.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.","schema":{"type":"string","example":""}},{"name":"scope","in":"query","description":"The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["development","runtime"]}}},{"name":"severity","in":"query","description":"A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","epss_percentage"]}}},{"name":"state","in":"query","description":"A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/dependabot/alerts"},"summary":"List Dependabot alerts for an enterprise","description":"Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/dependabot/repository-access":{"get":{"tags":["Dependabot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of results to fetch.","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/dependabot/repository-access"},"summary":"Lists the repositories Dependabot can access in an enterprise","description":"Lists repositories that enterprise admins have allowed Dependabot to access when updating dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Dependabot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/dependabot/repository-access"},"summary":"Updates Dependabot's repository access list for an enterprise","description":"Updates repositories according to the list of repositories that enterprise admins have given Dependabot access to when they've updated dependencies across organizations in the enterprise.\n\nThe authenticated user must be an enterprise owner to use this endpoint.\n\n**Example request body:**\n```json\n{\n  \"repository_ids_to_add\": [123, 456],\n  \"repository_ids_to_remove\": [789]\n}\n```","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"repository_ids_to_add":{"type":"array","description":"List of repository IDs to add.","items":{"type":"number"}},"repository_ids_to_remove":{"type":"array","description":"List of repository IDs to remove.","items":{"type":"number"}}}},"example":{"repository_ids_to_add":[],"repository_ids_to_remove":[]}}}}}},"/enterprises/{enterprise}/dependabot/repository-access/default-level":{"put":{"tags":["Dependabot"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot-in-an-enterprise","api_endpoint":"https://api.github.com/enterprises/{enterprise}/dependabot/repository-access/default-level"},"summary":"Set the default repository access level for Dependabot in an enterprise","description":"Sets the default level of repository access Dependabot will have while performing an update across organizations in the enterprise. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nThe authenticated user must be an enterprise owner to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"default_level":{"type":"string","description":"The default repository access level for Dependabot updates.","required":true,"enum":["public","internal"]}}},"example":{"default_level":""}}}}}},"/enterprises/{enterprise}/members/{username}/teams":{"get":{"tags":["Enterprise Team Memberships"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-enterprise-teams-for-a-user","api_endpoint":"https://api.github.com/enterprises/{enterprise}/members/{username}/teams"},"summary":"List enterprise teams for a user","description":"Lists all enterprise teams that a user is a member of. This endpoint is available only for\nenterprises using the new enterprise teams experience.\n\nThe authenticated user must be an enterprise owner or have the `enterprise_teams:read` permission.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/teams":{"get":{"tags":["Enterprise Teams"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams"},"summary":"List enterprise teams","description":"List all teams in the enterprise for the authenticated user","security":[{"bearerAuth":[]}]},"post":{"tags":["Enterprise Teams"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams"},"summary":"Create an enterprise team","description":"To create an enterprise team, the authenticated user must be an owner of the enterprise.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A description of the team."},"group_id":{"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/rest/scim#list-provisioned-scim-groups-for-an-enterprise)."},"name":{"type":"string","description":"The name of the team.","required":true},"notification_setting":{"type":"string","description":"The notification setting the team is set to. The options are:\n\n* `notifications_enabled` - team members receive notifications when the team is @mentioned.\n* `notifications_disabled` - no one receives notifications.\n\nDefault: `notifications_enabled`\n","enum":["notifications_enabled","notifications_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`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n","enum":["disabled","selected","all"]},"sync_to_organizations":{"type":"string","description":"Retired: this field is no longer supported.\nWhether the enterprise team should be reflected in each organization.\nThis value cannot be set.\n","enum":["all","disabled"]}}},"example":{"description":"","group_id":"","name":"","notification_setting":"","organization_selection_type":"","sync_to_organizations":""}}}}}},"/enterprises/{enterprise}/teams/{enterprise-team}/memberships":{"get":{"tags":["Enterprise Team Memberships"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/memberships"},"summary":"List members in an enterprise team","description":"Lists all team members in an enterprise team.","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add":{"post":{"tags":["Enterprise Team Memberships"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add"},"summary":"Bulk add team members","description":"Add multiple team members to an enterprise team.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"usernames":{"type":"array","description":"The GitHub user handles to add to the team.","required":true,"items":{"type":"string"}}}},"example":{"usernames":[]}}}}}},"/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove":{"post":{"tags":["Enterprise Team Memberships"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove"},"summary":"Bulk remove team members","description":"Remove multiple team members from an enterprise team.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"usernames":{"type":"array","description":"The GitHub user handles to be removed from the team.","required":true,"items":{"type":"string"}}}},"example":{"usernames":[]}}}}}},"/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}":{"get":{"tags":["Enterprise Team Memberships"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}"},"summary":"Get enterprise team membership","description":"Returns whether the user is a member of the enterprise team.","security":[{"bearerAuth":[]}]},"put":{"tags":["Enterprise Team Memberships"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}"},"summary":"Add team member","description":"Add a team member to an enterprise team.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Enterprise Team Memberships"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}"},"summary":"Remove team membership","description":"Remove membership of a specific user from a particular team in an enterprise.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/enterprises/{enterprise}/teams/{enterprise-team}/organizations":{"get":{"tags":["Enterprise Team Organizations"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/organizations"},"summary":"Get organization assignments","description":"Get all organizations assigned to an enterprise team","security":[{"bearerAuth":[]}]}},"/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add":{"post":{"tags":["Enterprise Team Organizations"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add"},"summary":"Add organization assignments","description":"Assign an enterprise team to multiple organizations.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"organization_slugs":{"type":"array","description":"Organization slug to assign the team to.","required":true,"items":{"type":"string"}}}},"example":{"organization_slugs":[]}}}}}},"/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove":{"post":{"tags":["Enterprise Team Organizations"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove"},"summary":"Remove organization assignments","description":"Unassign an enterprise team from multiple organizations.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"organization_slugs":{"type":"array","description":"Organization slug to unassign the team from.","required":true,"items":{"type":"string"}}}},"example":{"organization_slugs":[]}}}}}},"/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}":{"get":{"tags":["Enterprise Team Organizations"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}"},"summary":"Get organization assignment","description":"Check if an enterprise team is assigned to an organization","security":[{"bearerAuth":[]}]},"put":{"tags":["Enterprise Team Organizations"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}"},"summary":"Add an organization assignment","description":"Assign an enterprise team to an organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Enterprise Team Organizations"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"enterprise-team","in":"path","description":"The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}"},"summary":"Delete an organization assignment","description":"Unassign an enterprise team from an organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/enterprises/{enterprise}/teams/{team_slug}":{"get":{"tags":["Enterprise Teams"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{team_slug}"},"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`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Enterprise Teams"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{team_slug}"},"summary":"Update an enterprise team","description":"To edit a team, the authenticated user must be an enterprise owner.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A new description for the team."},"group_id":{"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."},"name":{"type":"string","description":"A new name for the team."},"notification_setting":{"type":"string","description":"The notification setting the team is set to. The options are:\n\n* `notifications_enabled` - team members receive notifications when the team is @mentioned.\n* `notifications_disabled` - no one receives notifications.\n","enum":["notifications_enabled","notifications_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`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n","enum":["disabled","selected","all"]},"sync_to_organizations":{"type":"string","description":"Retired: this field is no longer supported.\nWhether the enterprise team should be reflected in each organization.\nThis value cannot be changed.\n","enum":["all","disabled"]}}},"example":{"description":"","group_id":"","name":"","notification_setting":"","organization_selection_type":"","sync_to_organizations":""}}}}},"delete":{"tags":["Enterprise Teams"],"parameters":[{"name":"enterprise","in":"path","description":"The slug version of the enterprise name.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team","api_endpoint":"https://api.github.com/enterprises/{enterprise}/teams/{team_slug}"},"summary":"Delete an enterprise team","description":"To delete an enterprise team, the authenticated user must be an enterprise owner.\n\nIf you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/events":{"get":{"tags":["Activity"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-public-events","api_endpoint":"https://api.github.com/events"},"summary":"List public events","description":"> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/feeds":{"get":{"tags":["Activity"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/feeds#get-feeds","api_endpoint":"https://api.github.com/feeds"},"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.\n\n*   **Timeline**: The GitHub global public timeline\n*   **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n*   **Current user public**: The public timeline for the authenticated user\n*   **Current user**: The private timeline for the authenticated user\n*   **Current user actor**: The private timeline for activity created by the authenticated user\n*   **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n*   **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\nBy 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/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.","security":[{"bearerAuth":[]}]}},"/gists":{"get":{"tags":["Gists"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user","api_endpoint":"https://api.github.com/gists"},"summary":"List gists for the authenticated user","description":"Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:","security":[{"bearerAuth":[]}]},"post":{"tags":["Gists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#create-a-gist","api_endpoint":"https://api.github.com/gists"},"summary":"Create a gist","description":"Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description of the gist"},"files":{"type":"object","description":"Names and content for the files that make up the gist","required":true,"properties":{}},"public":{"type":"boolean","description":"public","enum":[true,false]}}},"example":{"description":"","files":{},"public":""}}}}}},"/gists/public":{"get":{"tags":["Gists"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#list-public-gists","api_endpoint":"https://api.github.com/gists/public"},"summary":"List public gists","description":"List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/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.","security":[{"bearerAuth":[]}]}},"/gists/starred":{"get":{"tags":["Gists"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#list-starred-gists","api_endpoint":"https://api.github.com/gists/starred"},"summary":"List starred gists","description":"List the authenticated user's starred gists:","security":[{"bearerAuth":[]}]}},"/gists/{gist_id}":{"get":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#get-a-gist","api_endpoint":"https://api.github.com/gists/{gist_id}"},"summary":"Get a gist","description":"Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#update-a-gist","api_endpoint":"https://api.github.com/gists/{gist_id}"},"summary":"Update a gist","description":"Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the gist."},"files":{"type":"object","description":"The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be\ndeleted if the specified object does not contain at least one of `content` or `filename`.","properties":{}}}},"example":{"description":"","files":{}}}}}},"delete":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#delete-a-gist","api_endpoint":"https://api.github.com/gists/{gist_id}"},"summary":"Delete a gist","description":"Delete a gist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/gists/{gist_id}/comments":{"get":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/comments#list-gist-comments","api_endpoint":"https://api.github.com/gists/{gist_id}/comments"},"summary":"List gist comments","description":"Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","security":[{"bearerAuth":[]}]},"post":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/comments#create-a-gist-comment","api_endpoint":"https://api.github.com/gists/{gist_id}/comments"},"summary":"Create a gist comment","description":"Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The comment text.","required":true}}},"example":{"body":""}}}}}},"/gists/{gist_id}/comments/{comment_id}":{"get":{"tags":["Gists"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/comments#get-a-gist-comment","api_endpoint":"https://api.github.com/gists/{gist_id}/comments/{comment_id}"},"summary":"Get a gist comment","description":"Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Gists"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/comments#update-a-gist-comment","api_endpoint":"https://api.github.com/gists/{gist_id}/comments/{comment_id}"},"summary":"Update a gist comment","description":"Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The comment text.","required":true}}},"example":{"body":""}}}}},"delete":{"tags":["Gists"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/comments#delete-a-gist-comment","api_endpoint":"https://api.github.com/gists/{gist_id}/comments/{comment_id}"},"summary":"Delete a gist comment","description":"Delete a gist comment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/gists/{gist_id}/commits":{"get":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#list-gist-commits","api_endpoint":"https://api.github.com/gists/{gist_id}/commits"},"summary":"List gist commits","description":"List gist commits","security":[{"bearerAuth":[]}]}},"/gists/{gist_id}/forks":{"get":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#list-gist-forks","api_endpoint":"https://api.github.com/gists/{gist_id}/forks"},"summary":"List gist forks","description":"List gist forks","security":[{"bearerAuth":[]}]},"post":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#fork-a-gist","api_endpoint":"https://api.github.com/gists/{gist_id}/forks"},"summary":"Fork a gist","description":"Fork a gist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/gists/{gist_id}/star":{"get":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred","api_endpoint":"https://api.github.com/gists/{gist_id}/star"},"summary":"Check if a gist is starred","description":"Check if a gist is starred","security":[{"bearerAuth":[]}]},"put":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#star-a-gist","api_endpoint":"https://api.github.com/gists/{gist_id}/star"},"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/rest/guides/getting-started-with-the-rest-api#http-method).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#unstar-a-gist","api_endpoint":"https://api.github.com/gists/{gist_id}/star"},"summary":"Unstar a gist","description":"Unstar a gist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/gists/{gist_id}/{sha}":{"get":{"tags":["Gists"],"parameters":[{"name":"gist_id","in":"path","description":"The unique identifier of the gist.","required":true,"schema":{"type":"string","example":""}},{"name":"sha","in":"path","description":"sha","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#get-a-gist-revision","api_endpoint":"https://api.github.com/gists/{gist_id}/{sha}"},"summary":"Get a gist revision","description":"Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.","security":[{"bearerAuth":[]}]}},"/gitignore/templates":{"get":{"tags":["Gitignore"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates","api_endpoint":"https://api.github.com/gitignore/templates"},"summary":"Get all gitignore templates","description":"List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).","security":[{"bearerAuth":[]}]}},"/gitignore/templates/{name}":{"get":{"tags":["Gitignore"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template","api_endpoint":"https://api.github.com/gitignore/templates/{name}"},"summary":"Get a gitignore template","description":"Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.","security":[{"bearerAuth":[]}]}},"/installation/repositories":{"get":{"tags":["Apps"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation","api_endpoint":"https://api.github.com/installation/repositories"},"summary":"List repositories accessible to the app installation","description":"List repositories that an app installation can access.","security":[{"bearerAuth":[]}]}},"/installation/token":{"delete":{"tags":["Apps"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token","api_endpoint":"https://api.github.com/installation/token"},"summary":"Revoke an installation access token","description":"Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce 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/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/issues":{"get":{"tags":["Issues"],"parameters":[{"name":"collab","in":"query","description":"collab","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"filter","in":"query","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.","schema":{"type":"string","example":"","items":{"type":"string","enum":["assigned","created","mentioned","subscribed","repos","all"]}}},{"name":"labels","in":"query","description":"A list of comma separated label names. Example: `bug,ui,@high`","schema":{"type":"string","example":""}},{"name":"orgs","in":"query","description":"orgs","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"owned","in":"query","description":"owned","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"pulls","in":"query","description":"pulls","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"What to sort results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","comments"]}}},{"name":"state","in":"query","description":"Indicates the state of the issues to return.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user","api_endpoint":"https://api.github.com/issues"},"summary":"List issues assigned to the authenticated user","description":"List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> 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/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/licenses":{"get":{"tags":["Licenses"],"parameters":[{"name":"featured","in":"query","description":"featured","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses","api_endpoint":"https://api.github.com/licenses"},"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/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"","security":[{"bearerAuth":[]}]}},"/licenses/{license}":{"get":{"tags":["Licenses"],"parameters":[{"name":"license","in":"path","description":"license","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/licenses/licenses#get-a-license","api_endpoint":"https://api.github.com/licenses/{license}"},"summary":"Get a license","description":"Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"","security":[{"bearerAuth":[]}]}},"/markdown":{"post":{"tags":["Markdown"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/markdown/markdown#render-a-markdown-document","api_endpoint":"https://api.github.com/markdown"},"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`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"The Markdown text to render in HTML.","required":true},"context":{"type":"string","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."},"mode":{"type":"string","description":"The rendering mode.","enum":["markdown","gfm"]}}},"example":{"text":"","context":"","mode":""}}}}}},"/markdown/raw":{"post":{"tags":["Markdown"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode","api_endpoint":"https://api.github.com/markdown/raw"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketplace_listing/accounts/{account_id}":{"get":{"tags":["Apps"],"parameters":[{"name":"account_id","in":"path","description":"account_id parameter","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account","api_endpoint":"https://api.github.com/marketplace_listing/accounts/{account_id}"},"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.\n\nGitHub Apps must use a [JWT](https://docs.github.com/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/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.","security":[{"bearerAuth":[]}]}},"/marketplace_listing/plans":{"get":{"tags":["Apps"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/marketplace#list-plans","api_endpoint":"https://api.github.com/marketplace_listing/plans"},"summary":"List plans","description":"Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/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/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.","security":[{"bearerAuth":[]}]}},"/marketplace_listing/plans/{plan_id}/accounts":{"get":{"tags":["Apps"],"parameters":[{"name":"plan_id","in":"path","description":"The unique identifier of the plan.","required":true,"schema":{"type":"number","example":""}},{"name":"direction","in":"query","description":"To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan","api_endpoint":"https://api.github.com/marketplace_listing/plans/{plan_id}/accounts"},"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.\n\nGitHub Apps must use a [JWT](https://docs.github.com/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/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.","security":[{"bearerAuth":[]}]}},"/marketplace_listing/stubbed/accounts/{account_id}":{"get":{"tags":["Apps"],"parameters":[{"name":"account_id","in":"path","description":"account_id parameter","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed","api_endpoint":"https://api.github.com/marketplace_listing/stubbed/accounts/{account_id}"},"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.\n\nGitHub Apps must use a [JWT](https://docs.github.com/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/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.","security":[{"bearerAuth":[]}]}},"/marketplace_listing/stubbed/plans":{"get":{"tags":["Apps"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/marketplace#list-plans-stubbed","api_endpoint":"https://api.github.com/marketplace_listing/stubbed/plans"},"summary":"List plans (stubbed)","description":"Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/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/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.","security":[{"bearerAuth":[]}]}},"/marketplace_listing/stubbed/plans/{plan_id}/accounts":{"get":{"tags":["Apps"],"parameters":[{"name":"plan_id","in":"path","description":"The unique identifier of the plan.","required":true,"schema":{"type":"number","example":""}},{"name":"direction","in":"query","description":"To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed","api_endpoint":"https://api.github.com/marketplace_listing/stubbed/plans/{plan_id}/accounts"},"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.\n\nGitHub Apps must use a [JWT](https://docs.github.com/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/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.","security":[{"bearerAuth":[]}]}},"/meta":{"get":{"tags":["Meta"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/meta/meta#get-apiname-meta-information","api_endpoint":"https://api.github.com/meta"},"summary":"Get GitHub 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/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names, and the public keys used by GitHub to sign commits made through the web UI.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/networks/{owner}/{repo}/events":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories","api_endpoint":"https://api.github.com/networks/{owner}/{repo}/events"},"summary":"List public events for a network of repositories","description":"> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/notifications":{"get":{"tags":["Activity"],"parameters":[{"name":"all","in":"query","description":"If `true`, show notifications marked as read.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"before","in":"query","description":"Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"participating","in":"query","description":"If `true`, only shows notifications in which the user is directly participating or mentioned.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"per_page","in":"query","description":"The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user","api_endpoint":"https://api.github.com/notifications"},"summary":"List notifications for the authenticated user","description":"List all notifications for the current user, sorted by most recently updated.","security":[{"bearerAuth":[]}]},"put":{"tags":["Activity"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#mark-notifications-as-read","api_endpoint":"https://api.github.com/notifications"},"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 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/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"last_read_at":{"type":"string","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."},"read":{"type":"boolean","description":"Whether the notification has been read.","enum":[true,false]}}},"example":{"last_read_at":"","read":""}}}}}},"/notifications/threads/{thread_id}":{"get":{"tags":["Activity"],"parameters":[{"name":"thread_id","in":"path","description":"The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#get-a-thread","api_endpoint":"https://api.github.com/notifications/threads/{thread_id}"},"summary":"Get a thread","description":"Gets information about a notification thread.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Activity"],"parameters":[{"name":"thread_id","in":"path","description":"The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read","api_endpoint":"https://api.github.com/notifications/threads/{thread_id}"},"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: https://github.com/notifications.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Activity"],"parameters":[{"name":"thread_id","in":"path","description":"The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done","api_endpoint":"https://api.github.com/notifications/threads/{thread_id}"},"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 as done: https://github.com/notifications.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/notifications/threads/{thread_id}/subscription":{"get":{"tags":["Activity"],"parameters":[{"name":"thread_id","in":"path","description":"The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user","api_endpoint":"https://api.github.com/notifications/threads/{thread_id}/subscription"},"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/rest/activity/watching#get-a-repository-subscription).\n\nNote 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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Activity"],"parameters":[{"name":"thread_id","in":"path","description":"The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#set-a-thread-subscription","api_endpoint":"https://api.github.com/notifications/threads/{thread_id}/subscription"},"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**.\n\nYou 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.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ignored":{"type":"boolean","description":"Whether to block all notifications from a thread.","enum":[true,false]}}},"example":{"ignored":""}}}}},"delete":{"tags":["Activity"],"parameters":[{"name":"thread_id","in":"path","description":"The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription","api_endpoint":"https://api.github.com/notifications/threads/{thread_id}/subscription"},"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/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/octocat":{"get":{"tags":["Meta"],"parameters":[{"name":"s","in":"query","description":"The words to show in Octocat's speech bubble","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/meta/meta#get-octocat","api_endpoint":"https://api.github.com/octocat"},"summary":"Get Octocat","description":"Get the octocat as ASCII art","security":[{"bearerAuth":[]}]}},"/organizations":{"get":{"tags":["Organizations"],"parameters":[{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","description":"An organization ID. Only return organizations with an ID greater than this ID.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#list-organizations","api_endpoint":"https://api.github.com/organizations"},"summary":"List organizations","description":"Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.","security":[{"bearerAuth":[]}]}},"/organizations/{org}/actions/cache/retention-limit":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/actions/cache/retention-limit"},"summary":"Get GitHub Actions cache retention limit for an organization","description":"Gets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/actions/cache/retention-limit"},"summary":"Set GitHub Actions cache retention limit for an organization","description":"Sets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_cache_retention_days":{"type":"number","description":"For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained."}}},"example":{"max_cache_retention_days":""}}}}}},"/organizations/{org}/actions/cache/storage-limit":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/actions/cache/storage-limit"},"summary":"Get GitHub Actions cache storage limit for an organization","description":"Gets GitHub Actions cache storage limit for an organization. All repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/actions/cache/storage-limit"},"summary":"Set GitHub Actions cache storage limit for an organization","description":"Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_cache_size_gb":{"type":"number","description":"For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes."}}},"example":{"max_cache_size_gb":""}}}}}},"/organizations/{org}/settings/billing/ai_credit/usage":{"get":{"tags":["Billing"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.","schema":{"type":"number","example":""}},{"name":"model","in":"query","description":"The model name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"month","in":"query","description":"If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.","schema":{"type":"number","example":""}},{"name":"product","in":"query","description":"The product name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"user","in":"query","description":"The user name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"year","in":"query","description":"If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/usage#get-billing-ai-credit-usage-report-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/ai_credit/usage"},"summary":"Get billing AI credit usage report for an organization","description":"Gets a report of AI credit usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.","security":[{"bearerAuth":[]}]}},"/organizations/{org}/settings/billing/budgets":{"get":{"tags":["Billing"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch.","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 100).","schema":{"type":"number","example":""}},{"name":"scope","in":"query","description":"Filter budgets by scope type.\n\n- `organization`: Budgets scoped to the organization.\n- `repository`: Budgets scoped to a repository.\n- `multi_user_customer`: Universal budgets that apply to all users in the organization.\n- `user`: Budgets scoped to an individual user.","schema":{"type":"string","example":"","items":{"type":"string","enum":["enterprise","organization","repository","cost_center","multi_user_customer","user"]}}},{"name":"user","in":"query","description":"Filter consumed amount details for budgets by the specified user login.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/budgets"},"summary":"Get all budgets for an organization","description":"Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 100 budgets.","security":[{"bearerAuth":[]}]},"post":{"tags":["Billing"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/budgets#create-a-budget-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/budgets"},"summary":"Create a budget for an organization","description":"Creates a new budget for an organization. The authenticated user must be an\norganization admin or billing manager.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"budget_alerting":{"type":"object","description":"budget_alerting","properties":{"alert_recipients":{"type":"array","description":"Array of user login names who will receive alerts. Rejected for user-scope as alerting is always disabled for them."},"will_alert":{"type":"boolean","description":"Whether alerts are enabled for this budget. Rejected for user-scope as alerting is always disabled for them.","enum":[true,false]}}},"budget_amount":{"type":"number","description":"The budget amount in whole dollars. For license-based products, this represents the number of licenses."},"budget_entity_name":{"type":"string","description":"The name of the entity to apply the budget to"},"budget_product_sku":{"type":"string","description":"A single product or SKU that will be covered in the budget"},"budget_scope":{"type":"string","description":"The scope of the budget for this organization.\n\n- `organization`: Apply the budget to the organization.\n- `repository`: Apply the budget to a specific repository in the organization.\n- `multi_user_customer`: Apply a universal budget to all users in the organization.\n- `user`: Apply the budget to a single user in the organization.\n\n`user` and `multi_user_customer` scopes are only supported when\n`budget_product_sku` is `ai_credits` or `premium_requests`.","enum":["organization","repository","multi_user_customer","user"]},"budget_type":{"type":"string","description":"The type of pricing model used by the budget. Determines how `budget_product_sku` is interpreted.\n\n- `BundlePricing`: Covers all AI credit SKUs. Set `budget_product_sku` to `ai_credits`.\n- `ProductPricing`: Covers all SKUs that belong to a product. Set `budget_product_sku` to a product such as `actions` or `packages`.\n- `SkuPricing`: Covers a single, specific SKU. Set `budget_product_sku` to a SKU such as `actions_linux`."},"expires_at":{"type":"string","description":"The date the budget will expire in `YYYY-MM-DD` format. Only dates in the future are accepted.\nIf not provided, the budget will not expire.\n\nOnly supported for budgets with `budget_scope` of `user`"},"prevent_further_usage":{"type":"boolean","description":"Whether to prevent additional spending once the budget is exceeded. For `user` and `multi_user_customer` scopes, this must be `true`.","enum":[true,false]},"user":{"type":"string","description":"The username of the user for `user` scope budgets. This field is required when `budget_scope` is `user`."}}},"example":{"budget_alerting":{},"budget_amount":"","budget_entity_name":"","budget_product_sku":"","budget_scope":"","budget_type":"","expires_at":"","prevent_further_usage":"","user":""}}}}}},"/organizations/{org}/settings/billing/budgets/{budget_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"budget_id","in":"path","description":"The ID corresponding to the budget.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/budgets/{budget_id}"},"summary":"Get a budget by ID for an organization","description":"Gets a budget by ID. The authenticated user must be an organization admin or billing manager.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Billing"],"parameters":[{"name":"budget_id","in":"path","description":"The ID corresponding to the budget.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/budgets/{budget_id}"},"summary":"Update a budget for an organization","description":"Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"budget_alerting":{"type":"object","description":"budget_alerting","properties":{"alert_recipients":{"type":"array","description":"Array of user login names who will receive alerts. Ignored for user-scopes as alerting is always disabled for them."},"will_alert":{"type":"boolean","description":"Whether alerts are enabled for this budget. Ignored for user-scopes as alerting is always disabled for them.","enum":[true,false]}}},"budget_amount":{"type":"number","description":"The budget amount in whole dollars. For license-based products, this represents the number of licenses."},"budget_entity_name":{"type":"string","description":"The name of the entity to apply the budget to"},"budget_product_sku":{"type":"string","description":"A single product or SKU that will be covered in the budget"},"budget_scope":{"type":"string","description":"The scope of the budget for this organization.\n\n- `organization`: Apply the budget to the organization.\n- `repository`: Apply the budget to a specific repository in the organization.\n- `multi_user_customer`: Apply a universal budget to all users in the organization.\n- `user`: Apply the budget to a single user in the organization.","enum":["enterprise","organization","repository","cost_center","multi_user_customer","user"]},"budget_type":{"type":"string","description":"The type of pricing model used by the budget. Determines how `budget_product_sku` is interpreted.\n\n- `BundlePricing`: Covers all AI credit SKUs. Set `budget_product_sku` to `ai_credits`.\n- `ProductPricing`: Covers all SKUs that belong to a product. Set `budget_product_sku` to a product such as `actions` or `packages`.\n- `SkuPricing`: Covers a single, specific SKU. Set `budget_product_sku` to a SKU such as `actions_linux`."},"expires_at":{"type":"string","description":"The date the budget will expire in `YYYY-MM-DD` format. Only dates in the future are accepted.\nIf not set, the budget will not expire. Setting to `null` or `0` will remove the expiration date from a budget if set.\n\nOnly supported for budgets with `budget_scope` of `user`"},"prevent_further_usage":{"type":"boolean","description":"Whether to prevent additional spending once the budget is exceeded. For budgets with `user` or `multi_user_customer` scope, this must remain `true`.","enum":[true,false]},"user":{"type":"string","description":"The username of the user for `user` scope budgets."}}},"example":{"budget_alerting":{},"budget_amount":"","budget_entity_name":"","budget_product_sku":"","budget_scope":"","budget_type":"","expires_at":"","prevent_further_usage":"","user":""}}}}},"delete":{"tags":["Billing"],"parameters":[{"name":"budget_id","in":"path","description":"The ID corresponding to the budget.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/budgets/{budget_id}"},"summary":"Delete a budget for an organization","description":"Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/organizations/{org}/settings/billing/premium_request/usage":{"get":{"tags":["Billing"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.","schema":{"type":"number","example":""}},{"name":"model","in":"query","description":"The model name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"month","in":"query","description":"If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.","schema":{"type":"number","example":""}},{"name":"product","in":"query","description":"The product name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"user","in":"query","description":"The user name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"year","in":"query","description":"If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/premium_request/usage"},"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.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.","security":[{"bearerAuth":[]}]}},"/organizations/{org}/settings/billing/usage":{"get":{"tags":["Billing"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.","schema":{"type":"number","example":""}},{"name":"month","in":"query","description":"If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.","schema":{"type":"number","example":""}},{"name":"year","in":"query","description":"If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/usage"},"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.\n\n**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/billing/using-the-new-billing-platform).\"","security":[{"bearerAuth":[]}]}},"/organizations/{org}/settings/billing/usage/summary":{"get":{"tags":["Billing"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.","schema":{"type":"number","example":""}},{"name":"month","in":"query","description":"If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.","schema":{"type":"number","example":""}},{"name":"product","in":"query","description":"The product name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"repository","in":"query","description":"The repository name to query for usage in the format owner/repository.","schema":{"type":"string","example":""}},{"name":"sku","in":"query","description":"The SKU to query for usage.","schema":{"type":"string","example":""}},{"name":"year","in":"query","description":"If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization","api_endpoint":"https://api.github.com/organizations/{org}/settings/billing/usage/summary"},"summary":"Get billing usage summary for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets 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.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#get-an-organization","api_endpoint":"https://api.github.com/orgs/{org}"},"summary":"Get an organization","description":"Gets information about an organization.\n\nWhen 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/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#update-an-organization","api_endpoint":"https://api.github.com/orgs/{org}"},"summary":"Update an organization","description":"> [!WARNING]\n> **Closing down notice:** GitHub 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).\n\n> [!WARNING]\n> **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/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/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"advanced_security_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","enum":[true,false]},"billing_email":{"type":"string","description":"Billing email address. This address is not publicized."},"blog":{"type":"string","description":"blog"},"company":{"type":"string","description":"The company name."},"default_repository_permission":{"type":"string","description":"Default permission level members have for organization repositories.","enum":["read","write","admin","none"]},"dependabot_alerts_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","enum":[true,false]},"dependabot_security_updates_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","enum":[true,false]},"dependency_graph_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","enum":[true,false]},"deploy_keys_enabled_for_repositories":{"type":"boolean","description":"Controls whether or not deploy keys may be added and used for repositories in the organization.","enum":[true,false]},"description":{"type":"string","description":"The description of the company. The maximum size is 160 characters."},"email":{"type":"string","description":"The publicly visible email address."},"has_organization_projects":{"type":"boolean","description":"Whether an organization can use organization projects.","enum":[true,false]},"has_repository_projects":{"type":"boolean","description":"Whether repositories that belong to the organization can use repository projects.","enum":[true,false]},"location":{"type":"string","description":"The location."},"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_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/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.","enum":[true,false]},"members_can_create_pages":{"type":"boolean","description":"Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.","enum":[true,false]},"members_can_create_private_pages":{"type":"boolean","description":"Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.","enum":[true,false]},"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/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.","enum":[true,false]},"members_can_create_public_pages":{"type":"boolean","description":"Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.","enum":[true,false]},"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/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.","enum":[true,false]},"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.","enum":[true,false]},"members_can_fork_private_repositories":{"type":"boolean","description":"Whether organization members can fork private organization repositories.","enum":[true,false]},"name":{"type":"string","description":"The shorthand name of the company."},"secret_scanning_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","enum":[true,false]},"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_push_protection_enabled_for_new_repositories":{"type":"boolean","description":"**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.","enum":[true,false]},"twitter_username":{"type":"string","description":"The Twitter username of the company."},"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.","enum":[true,false]}}},"example":{"advanced_security_enabled_for_new_repositories":"","billing_email":"","blog":"","company":"","default_repository_permission":"","dependabot_alerts_enabled_for_new_repositories":"","dependabot_security_updates_enabled_for_new_repositories":"","dependency_graph_enabled_for_new_repositories":"","deploy_keys_enabled_for_repositories":"","description":"","email":"","has_organization_projects":"","has_repository_projects":"","location":"","members_allowed_repository_creation_type":"","members_can_create_internal_repositories":"","members_can_create_pages":"","members_can_create_private_pages":"","members_can_create_private_repositories":"","members_can_create_public_pages":"","members_can_create_public_repositories":"","members_can_create_repositories":"","members_can_fork_private_repositories":"","name":"","secret_scanning_enabled_for_new_repositories":"","secret_scanning_push_protection_custom_link":"","secret_scanning_push_protection_enabled_for_new_repositories":"","twitter_username":"","web_commit_signoff_required":""}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#delete-an-organization","api_endpoint":"https://api.github.com/orgs/{org}"},"summary":"Delete an organization","description":"Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/cache/usage":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/cache/usage"},"summary":"Get GitHub Actions cache usage for an organization","description":"Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/cache/usage-by-repository":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/cache/usage-by-repository"},"summary":"List repositories with GitHub Actions cache usage for an organization","description":"Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/hosted-runners":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners"},"summary":"List GitHub-hosted runners for an organization","description":"Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners"},"summary":"Create a GitHub-hosted runner for an organization","description":"Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enable_static_ip":{"type":"boolean","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`","enum":[true,false]},"image":{"type":"object","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`.","required":true,"properties":{"id":{"type":"string","description":"The unique identifier of the runner image."},"source":{"type":"string","description":"The source of the runner image.","enum":["github","partner","custom"]},"version":{"type":"string","description":"The version of the runner image to deploy. This is relevant only for runners using custom images."}}},"image_gen":{"type":"boolean","description":"Whether this runner should be used to generate custom images.","enum":[true,false]},"maximum_runners":{"type":"number","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."},"name":{"type":"string","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 '_'.","required":true},"runner_group_id":{"type":"number","description":"The existing runner group to add this runner to.","required":true},"size":{"type":"string","description":"The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`","required":true}}},"example":{"enable_static_ip":"","image":{},"image_gen":"","maximum_runners":"","name":"","runner_group_id":"","size":""}}}}}},"/orgs/{org}/actions/hosted-runners/images/custom":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/images/custom"},"summary":"List custom images for an organization","description":"List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"image_definition_id","in":"path","description":"Image definition ID of custom image","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}"},"summary":"Get a custom image definition for GitHub Actions Hosted Runners","description":"Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Actions"],"parameters":[{"name":"image_definition_id","in":"path","description":"Image definition ID of custom image","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}"},"summary":"Delete a custom image from the organization","description":"Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions":{"get":{"tags":["Actions"],"parameters":[{"name":"image_definition_id","in":"path","description":"Image definition ID of custom image","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions"},"summary":"List image versions of a custom image for an organization","description":"List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}":{"get":{"tags":["Actions"],"parameters":[{"name":"image_definition_id","in":"path","description":"Image definition ID of custom image","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"version","in":"path","description":"Version of a custom image","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}"},"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.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Actions"],"parameters":[{"name":"image_definition_id","in":"path","description":"Image definition ID of custom image","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"version","in":"path","description":"Version of a custom image","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}"},"summary":"Delete an image version of custom image from the organization","description":"Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/hosted-runners/images/github-owned":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/images/github-owned"},"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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/hosted-runners/images/partner":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/images/partner"},"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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/hosted-runners/limits":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/limits"},"summary":"Get limits on GitHub-hosted runners for an organization","description":"Get the GitHub-hosted runners limits for an organization.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/hosted-runners/machine-sizes":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/machine-sizes"},"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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/hosted-runners/platforms":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/platforms"},"summary":"Get platforms for GitHub-hosted runners in an organization","description":"Get the list of platforms available for GitHub-hosted runners for an organization.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/hosted-runners/{hosted_runner_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"hosted_runner_id","in":"path","description":"Unique identifier of the GitHub-hosted runner.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/{hosted_runner_id}"},"summary":"Get a GitHub-hosted runner for an organization","description":"Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Actions"],"parameters":[{"name":"hosted_runner_id","in":"path","description":"Unique identifier of the GitHub-hosted runner.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/{hosted_runner_id}"},"summary":"Update a GitHub-hosted runner for an organization","description":"Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enable_static_ip":{"type":"boolean","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`","enum":[true,false]},"image_gen":{"type":"boolean","description":"Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.","enum":[true,false]},"image_id":{"type":"string","description":"The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`."},"image_source":{"type":"string","description":"The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.","enum":["github","partner","custom"]},"image_version":{"type":"string","description":"The version of the runner image to deploy. This is relevant only for runners using custom images."},"maximum_runners":{"type":"number","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."},"name":{"type":"string","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 '_'."},"runner_group_id":{"type":"number","description":"The existing runner group to add this runner to."},"size":{"type":"string","description":"The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`"}}},"example":{"enable_static_ip":"","image_gen":"","image_id":"","image_source":"","image_version":"","maximum_runners":"","name":"","runner_group_id":"","size":""}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"hosted_runner_id","in":"path","description":"Unique identifier of the GitHub-hosted runner.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/hosted-runners/{hosted_runner_id}"},"summary":"Delete a GitHub-hosted runner for an organization","description":"Deletes a GitHub-hosted runner for an organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/oidc/customization/properties/repo":{"get":{"tags":["OIDC"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/oidc/customization/properties/repo"},"summary":"List OIDC custom property inclusions for an organization","description":"Lists the repository custom properties that are included in the OIDC token for repository actions in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["OIDC"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/oidc/customization/properties/repo"},"summary":"Create an OIDC custom property inclusion for an organization","description":"Adds a repository custom property to be included in the OIDC token for repository actions in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_property_name":{"type":"string","description":"The name of the custom property to include in the OIDC token","required":true}}},"example":{"custom_property_name":""}}}}}},"/orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name}":{"delete":{"tags":["OIDC"],"parameters":[{"name":"custom_property_name","in":"path","description":"The name of the custom property to remove from OIDC token inclusion","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name}"},"summary":"Delete an OIDC custom property inclusion for an organization","description":"Removes a repository custom property from being included in the OIDC token for repository actions in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/oidc/customization/sub":{"get":{"tags":["OIDC"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/oidc/customization/sub"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["OIDC"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/oidc/customization/sub"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"include_claim_keys":{"type":"array","description":"Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.","items":{"type":"string"}},"use_immutable_subject":{"type":"boolean","description":"Whether to opt in to the immutable OIDC subject claim format for the organization. When `true`, new OIDC tokens will use a stable, repository-ID-based `sub` claim instead of the name-based format.","enum":[true,false]}}},"example":{"include_claim_keys":[],"use_immutable_subject":""}}}}}},"/orgs/{org}/actions/permissions":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions"},"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.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions"},"summary":"Set GitHub Actions permissions for an organization","description":"Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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"]},"enabled_repositories":{"type":"string","description":"The policy that controls the repositories in the organization that are allowed to run GitHub Actions.","required":true,"enum":["all","none","selected"]},"sha_pinning_required":{"type":"boolean","description":"Whether actions must be pinned to a full-length commit SHA.","enum":[true,false]}}},"example":{"allowed_actions":"","enabled_repositories":"","sha_pinning_required":""}}}}}},"/orgs/{org}/actions/permissions/artifact-and-log-retention":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/artifact-and-log-retention"},"summary":"Get artifact and log retention settings for an organization","description":"Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/artifact-and-log-retention"},"summary":"Set artifact and log retention settings for an organization","description":"Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"days":{"type":"number","description":"The number of days to retain artifacts and logs","required":true}}},"example":{"days":""}}}}}},"/orgs/{org}/actions/permissions/fork-pr-contributor-approval":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/fork-pr-contributor-approval"},"summary":"Get fork PR contributor approval permissions for an organization","description":"Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/fork-pr-contributor-approval"},"summary":"Set fork PR contributor approval permissions for an organization","description":"Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"approval_policy":{"type":"string","description":"The policy that controls when fork PR workflows require approval from a maintainer.","required":true,"enum":["first_time_contributors_new_to_github","first_time_contributors","all_external_contributors"]}}},"example":{"approval_policy":""}}}}}},"/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos"},"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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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.","enum":[true,false]},"run_workflows_from_fork_pull_requests":{"type":"boolean","description":"Whether workflows triggered by pull requests from forks are allowed to run on private repositories.","required":true,"enum":[true,false]},"send_secrets_and_variables":{"type":"boolean","description":"Whether to make secrets and variables available to workflows triggered by pull requests from forks.","enum":[true,false]},"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.","enum":[true,false]}}},"example":{"require_approval_for_fork_pr_workflows":"","run_workflows_from_fork_pull_requests":"","send_secrets_and_variables":"","send_write_tokens_to_workflows":""}}}}}},"/orgs/{org}/actions/permissions/repositories":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/repositories"},"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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/repositories"},"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).\"\n\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_repository_ids":{"type":"array","description":"List of repository IDs to enable for GitHub Actions.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/actions/permissions/repositories/{repository_id}":{"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/repositories/{repository_id}"},"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).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/repositories/{repository_id}"},"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).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/permissions/selected-actions":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/selected-actions"},"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).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/selected-actions"},"summary":"Set allowed actions and reusable workflows for an organization","description":"Sets the 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"github_owned_allowed":{"type":"boolean","description":"Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.","enum":[true,false]},"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/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.","items":{"type":"string"}},"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.","enum":[true,false]}}},"example":{"github_owned_allowed":"","patterns_allowed":[],"verified_allowed":""}}}}}},"/orgs/{org}/actions/permissions/self-hosted-runners":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/self-hosted-runners"},"summary":"Get self-hosted runners settings for an organization","description":"Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/self-hosted-runners"},"summary":"Set self-hosted runners settings for an organization","description":"Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enabled_repositories":{"type":"string","description":"The policy that controls whether self-hosted runners can be used in the organization","required":true,"enum":["all","selected","none"]}}},"example":{"enabled_repositories":""}}}}}},"/orgs/{org}/actions/permissions/self-hosted-runners/repositories":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/self-hosted-runners/repositories"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/self-hosted-runners/repositories"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_repository_ids":{"type":"array","description":"IDs of repositories that can use repository-level self-hosted runners","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}":{"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/permissions/workflow":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/workflow"},"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,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/permissions/workflow"},"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\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"can_approve_pull_request_reviews":{"type":"boolean","description":"Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.","enum":[true,false]},"default_workflow_permissions":{"type":"string","description":"The default workflow permissions granted to the GITHUB_TOKEN when running workflows.","enum":["read","write"]}}},"example":{"can_approve_pull_request_reviews":"","default_workflow_permissions":""}}}}}},"/orgs/{org}/actions/runner-groups":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"visible_to_repository","in":"query","description":"Only return runner groups that are allowed to be used by this repository.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups"},"summary":"Create a self-hosted runner group for an organization","description":"Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allows_public_repositories":{"type":"boolean","description":"Whether the runner group can be used by `public` repositories.","enum":[true,false]},"name":{"type":"string","description":"Name of the runner group.","required":true},"network_configuration_id":{"type":"string","description":"The identifier of a hosted compute network configuration."},"restricted_to_workflows":{"type":"boolean","description":"If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.","enum":[true,false]},"runners":{"type":"array","description":"List of runner IDs to add to the runner group.","items":{"type":"number"}},"selected_repository_ids":{"type":"array","description":"List of repository IDs that can access the runner group.","items":{"type":"number"}},"selected_workflows":{"type":"array","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`.","items":{"type":"string"}},"visibility":{"type":"string","description":"Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.","enum":["selected","all","private"]}}},"example":{"allows_public_repositories":"","name":"","network_configuration_id":"","restricted_to_workflows":"","runners":[],"selected_repository_ids":[],"selected_workflows":[],"visibility":""}}}}}},"/orgs/{org}/actions/runner-groups/{runner_group_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}"},"summary":"Get a self-hosted runner group for an organization","description":"Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allows_public_repositories":{"type":"boolean","description":"Whether the runner group can be used by `public` repositories.","enum":[true,false]},"name":{"type":"string","description":"Name of the runner group.","required":true},"network_configuration_id":{"type":"string","description":"The identifier of a hosted compute network configuration."},"restricted_to_workflows":{"type":"boolean","description":"If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.","enum":[true,false]},"selected_workflows":{"type":"array","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`.","items":{"type":"string"}},"visibility":{"type":"string","description":"Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.","enum":["selected","all","private"]}}},"example":{"allows_public_repositories":"","name":"","network_configuration_id":"","restricted_to_workflows":"","selected_workflows":[],"visibility":""}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}"},"summary":"Delete a self-hosted runner group from an organization","description":"Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners"},"summary":"List GitHub-hosted runners in a group for an organization","description":"Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_repository_ids":{"type":"array","description":"List of repository IDs that can access the runner group.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}":{"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}"},"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).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}"},"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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/runners"},"summary":"List self-hosted runners in a group for an organization","description":"Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/runners"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"runners":{"type":"array","description":"List of runner IDs to add to the runner group.","required":true,"items":{"type":"number"}}}},"example":{"runners":[]}}}}}},"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}":{"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}"},"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.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_group_id","in":"path","description":"Unique identifier of the self-hosted runner group.","required":true,"schema":{"type":"number","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/runners":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"The name of a self-hosted runner.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners"},"summary":"List self-hosted runners for an organization","description":"Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/runners/deprecations/{version}":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"version","in":"path","description":"The runner version to look up.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#get-runner-version-end-of-life-schedule-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/deprecations/{version}"},"summary":"Get runner version end-of-life schedule for an organization","description":"Gets the end-of-life schedule for a specific runner version in an organization. Returns the runner version\nand the dates when registration and runtime support will end.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/runners/downloads":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/downloads"},"summary":"List runner applications for an organization","description":"Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.  If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/runners/generate-jitconfig":{"post":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/generate-jitconfig"},"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.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.","required":true,"items":{"type":"string"}},"name":{"type":"string","description":"The name of the new runner.","required":true},"runner_group_id":{"type":"number","description":"The ID of the runner group to register the runner to.","required":true},"work_folder":{"type":"string","description":"The working directory to be used for job execution, relative to the runner install directory."}}},"example":{"labels":[],"name":"","runner_group_id":"","work_folder":""}}}}}},"/orgs/{org}/actions/runners/registration-token":{"post":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/registration-token"},"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.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/runners/remove-token":{"post":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/remove-token"},"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.\n\nFor 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:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/runners/{runner_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/{runner_id}"},"summary":"Get a self-hosted runner for an organization","description":"Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/{runner_id}"},"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.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/runners/{runner_id}/labels":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/{runner_id}/labels"},"summary":"List labels for a self-hosted runner for an organization","description":"Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]},"post":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/{runner_id}/labels"},"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.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"The names of the custom labels to add to the runner.","required":true,"items":{"type":"string"}}}},"example":{"labels":[]}}}}},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/{runner_id}/labels"},"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\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.","required":true,"items":{"type":"string"}}}},"example":{"labels":[]}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/{runner_id}/labels"},"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\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/runners/{runner_id}/labels/{name}":{"delete":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of a self-hosted runner's custom label.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/actions/runners/{runner_id}/labels/{name}"},"summary":"Remove a custom label from a self-hosted runner for an organization","description":"Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/secrets":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#list-organization-secrets","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets"},"summary":"List organization secrets","description":"Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/secrets/public-key":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#get-an-organization-public-key","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets/public-key"},"summary":"Get an organization public key","description":"Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/actions/secrets/{secret_name}":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#get-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets/{secret_name}"},"summary":"Get an organization secret","description":"Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets/{secret_name}"},"summary":"Create or update an organization secret","description":"Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/actions/secrets#get-an-organization-public-key) endpoint.","required":true},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret.","required":true},"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/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.","items":{"type":"number"}},"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.","required":true,"enum":["all","private","selected"]}}},"example":{"encrypted_value":"","key_id":"","selected_repository_ids":[],"visibility":""}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#delete-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets/{secret_name}"},"summary":"Delete an organization secret","description":"Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/secrets/{secret_name}/repositories":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets/{secret_name}/repositories"},"summary":"List selected repositories for an organization secret","description":"Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets/{secret_name}/repositories"},"summary":"Set selected repositories for an organization secret","description":"Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}":{"put":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Add selected repository to an organization secret","description":"Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Remove selected repository from an organization secret","description":"Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/variables":{"get":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#list-organization-variables","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables"},"summary":"List organization variables","description":"Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]},"post":{"tags":["Actions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#create-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables"},"summary":"Create an organization variable","description":"Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable.","required":true},"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":"number"}},"value":{"type":"string","description":"The value of the variable.","required":true},"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.","required":true,"enum":["all","private","selected"]}}},"example":{"name":"","selected_repository_ids":[],"value":"","visibility":""}}}}}},"/orgs/{org}/actions/variables/{name}":{"get":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#get-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables/{name}"},"summary":"Get an organization variable","description":"Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#update-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables/{name}"},"summary":"Update an organization variable","description":"Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable."},"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":"number"}},"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"]}}},"example":{"name":"","selected_repository_ids":[],"value":"","visibility":""}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#delete-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables/{name}"},"summary":"Delete an organization variable","description":"Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/actions/variables/{name}/repositories":{"get":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables/{name}/repositories"},"summary":"List selected repositories for an organization variable","description":"Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables/{name}/repositories"},"summary":"Set selected repositories for an organization variable","description":"Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_repository_ids":{"type":"array","description":"The IDs of the repositories that can access the organization variable.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/actions/variables/{name}/repositories/{repository_id}":{"put":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables/{name}/repositories/{repository_id}"},"summary":"Add selected repository to an organization variable","description":"Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/actions/variables/{name}/repositories/{repository_id}"},"summary":"Remove selected repository from an organization variable","description":"Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/agents/secrets":{"get":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#list-organization-secrets","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets"},"summary":"List organization secrets","description":"Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/agents/secrets/public-key":{"get":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#get-an-organization-public-key","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets/public-key"},"summary":"Get an organization public key","description":"Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/agents/secrets/{secret_name}":{"get":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#get-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets/{secret_name}"},"summary":"Get an organization secret","description":"Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#create-or-update-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets/{secret_name}"},"summary":"Create or update an organization secret","description":"Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/agents/secrets#get-an-organization-public-key) endpoint.","required":true},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret.","required":true},"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/rest/agents/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/agents/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/agents/secrets#remove-selected-repository-from-an-organization-secret) endpoints.","items":{"type":"number"}},"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.","required":true,"enum":["all","private","selected"]}}},"example":{"encrypted_value":"","key_id":"","selected_repository_ids":[],"visibility":""}}}}},"delete":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#delete-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets/{secret_name}"},"summary":"Delete an organization secret","description":"Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/agents/secrets/{secret_name}/repositories":{"get":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#list-selected-repositories-for-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets/{secret_name}/repositories"},"summary":"List selected repositories for an organization secret","description":"Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]},"put":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#set-selected-repositories-for-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets/{secret_name}/repositories"},"summary":"Set selected repositories for an organization secret","description":"Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/agents/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/agents/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/agents/secrets#remove-selected-repository-from-an-organization-secret) endpoints.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/agents/secrets/{secret_name}/repositories/{repository_id}":{"put":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#add-selected-repository-to-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Add selected repository to an organization secret","description":"Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/agents/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#remove-selected-repository-from-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/agents/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Remove selected repository from an organization secret","description":"Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/agents/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/agents/variables":{"get":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#list-organization-variables","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables"},"summary":"List organization variables","description":"Lists all agent variables available in an organization.\nReturned variables include their values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]},"post":{"tags":["Agents"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#create-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables"},"summary":"Create an organization variable","description":"Creates an organization agent variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable.","required":true},"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":"number"}},"value":{"type":"string","description":"The value of the variable.","required":true},"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.","required":true,"enum":["all","private","selected"]}}},"example":{"name":"","selected_repository_ids":[],"value":"","visibility":""}}}}}},"/orgs/{org}/agents/variables/{name}":{"get":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#get-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables/{name}"},"summary":"Get an organization variable","description":"Gets a specific agent variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#update-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables/{name}"},"summary":"Update an organization variable","description":"Updates an organization agent variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable."},"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":"number"}},"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"]}}},"example":{"name":"","selected_repository_ids":[],"value":"","visibility":""}}}}},"delete":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#delete-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables/{name}"},"summary":"Delete an organization variable","description":"Deletes an organization agent variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/agents/variables/{name}/repositories":{"get":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#list-selected-repositories-for-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables/{name}/repositories"},"summary":"List selected repositories for an organization variable","description":"Lists all repositories that can access an organization agent variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}]},"put":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#set-selected-repositories-for-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables/{name}/repositories"},"summary":"Set selected repositories for an organization variable","description":"Replaces all repositories for an organization agent variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_repository_ids":{"type":"array","description":"The IDs of the repositories that can access the organization variable.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/agents/variables/{name}/repositories/{repository_id}":{"put":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#add-selected-repository-to-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables/{name}/repositories/{repository_id}"},"summary":"Add selected repository to an organization variable","description":"Adds a repository to an organization agent variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#remove-selected-repository-from-an-organization-variable","api_endpoint":"https://api.github.com/orgs/{org}/agents/variables/{name}/repositories/{repository_id}"},"summary":"Remove selected repository from an organization variable","description":"Removes a repository from an organization agent variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/artifacts/metadata/deployment-record":{"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record","api_endpoint":"https://api.github.com/orgs/{org}/artifacts/metadata/deployment-record"},"summary":"Create an artifact deployment record","description":"Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cluster":{"type":"string","description":"The deployment cluster."},"deployment_name":{"type":"string","description":"The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n","required":true},"digest":{"type":"string","description":"The hex encoded digest of the artifact.","required":true},"github_repository":{"type":"string","description":"The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter."},"logical_environment":{"type":"string","description":"The stage of the deployment.","required":true},"name":{"type":"string","description":"The name of the artifact.","required":true},"physical_environment":{"type":"string","description":"The physical region of the deployment."},"return_records":{"type":"boolean","description":"If true, the endpoint will return the created or updated record in the response body.\n","enum":[true,false]},"runtime_risks":{"type":"array","description":"A list of runtime risks associated with the deployment.","items":{"type":"string"}},"status":{"type":"string","description":"The status of the artifact. Can be either deployed or decommissioned.","required":true,"enum":["deployed","decommissioned"]},"tags":{"type":"object","description":"The tags associated with the deployment.","properties":{}},"version":{"type":"string","description":"The artifact version."}}},"example":{"cluster":"","deployment_name":"","digest":"","github_repository":"","logical_environment":"","name":"","physical_environment":"","return_records":"","runtime_risks":[],"status":"","tags":{},"version":""}}}}}},"/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}":{"post":{"tags":["Organizations"],"parameters":[{"name":"cluster","in":"path","description":"The cluster name.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records","api_endpoint":"https://api.github.com/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}"},"summary":"Set cluster deployment records","description":"Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deployments":{"type":"array","description":"The list of deployments to record.","required":true,"items":{"type":"object","properties":{"deployment_name":{"type":"string","description":"The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n","required":true},"digest":{"type":"string","description":"The hex encoded digest of the artifact.","required":true},"github_repository":{"type":"string","description":"The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter."},"name":{"type":"string","description":"The name of the artifact.","required":true},"runtime_risks":{"type":"array","description":"A list of runtime risks associated with the deployment."},"status":{"type":"string","description":"The deployment status of the artifact.","enum":["deployed","decommissioned"]},"tags":{"type":"object","description":"Key-value pairs to tag the deployment record."},"version":{"type":"string","description":"The artifact version."}}}},"logical_environment":{"type":"string","description":"The stage of the deployment.","required":true},"partial_success":{"type":"boolean","description":"When enabled, deployments associated with repositories the actor can write to are processed\nwhile deployments associated with repositories that cannot be resolved or written to by the actor\nare skipped and reported in the `errors` array. When false (the default), the endpoint returns\nan error if any targeted repository cannot be resolved, the actor lacks write access, or no matching attestation can be found.\n","enum":[true,false]},"physical_environment":{"type":"string","description":"The physical region of the deployment."},"return_records":{"type":"boolean","description":"If true, the endpoint will return the set records in the response body\n","enum":[true,false]}}},"example":{"deployments":[],"logical_environment":"","partial_success":"","physical_environment":"","return_records":""}}}}}},"/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs":{"post":{"tags":["Organizations"],"parameters":[{"name":"cluster","in":"path","description":"The cluster name.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/artifact-metadata#create-a-cluster-deployment-records-job","api_endpoint":"https://api.github.com/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs"},"summary":"Create a cluster deployment records job","description":"Create a background job to set deployment records for a given cluster.\nPerforms validation and permission checks synchronously, returning rejected\ndeployments immediately, then enqueues a background job for the actual\ndeployment updates. Use the companion GET endpoint to poll for job status.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deployments":{"type":"array","description":"The list of deployments to record.","required":true,"items":{"type":"object","properties":{"deployment_name":{"type":"string","description":"The unique identifier for the deployment represented by the new record.\n","required":true},"digest":{"type":"string","description":"The hex encoded digest of the artifact.","required":true},"github_repository":{"type":"string","description":"The name of the GitHub repository associated with the artifact."},"name":{"type":"string","description":"The name of the artifact.","required":true},"runtime_risks":{"type":"array","description":"A list of runtime risks associated with the deployment."},"status":{"type":"string","description":"The deployment status of the artifact.","enum":["deployed","decommissioned"]},"tags":{"type":"object","description":"Key-value pairs to tag the deployment record."},"version":{"type":"string","description":"The artifact version."}}}},"logical_environment":{"type":"string","description":"The stage of the deployment.","required":true},"physical_environment":{"type":"string","description":"The physical region of the deployment."}}},"example":{"deployments":[],"logical_environment":"","physical_environment":""}}}}}},"/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs/{job_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"cluster","in":"path","description":"The cluster name.","required":true,"schema":{"type":"string","example":""}},{"name":"job_id","in":"path","description":"The ID of the job.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/artifact-metadata#get-cluster-deployment-records-job-status","api_endpoint":"https://api.github.com/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs/{job_id}"},"summary":"Get cluster deployment records job status","description":"Get the status and results of a previously created cluster deployment records job.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/artifacts/metadata/storage-record":{"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record","api_endpoint":"https://api.github.com/orgs/{org}/artifacts/metadata/storage-record"},"summary":"Create artifact metadata storage record","description":"Create metadata storage records for artifacts associated with an organization.\nThis endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and\nassociated with a repository owned by the organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"path":{"type":"string","description":"The path of the artifact."},"artifact_url":{"type":"string","description":"The URL where the artifact is stored."},"digest":{"type":"string","description":"The digest of the artifact (algorithm:hex-encoded-digest).","required":true},"github_repository":{"type":"string","description":"The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter."},"name":{"type":"string","description":"The name of the artifact.","required":true},"registry_url":{"type":"string","description":"The base URL of the artifact registry.","required":true},"repository":{"type":"string","description":"The repository name within the registry."},"return_records":{"type":"boolean","description":"If true, the endpoint will return the created record in the response body.\n","enum":[true,false]},"status":{"type":"string","description":"The status of the artifact (e.g., active, inactive).","enum":["active","eol","deleted"]},"version":{"type":"string","description":"The artifact version."}}},"example":{"path":"","artifact_url":"","digest":"","github_repository":"","name":"","registry_url":"","repository":"","return_records":"","status":"","version":""}}}}}},"/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"subject_digest","in":"path","description":"The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records","api_endpoint":"https://api.github.com/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records"},"summary":"List artifact deployment records","description":"List deployment records for an artifact metadata associated with an organization.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"subject_digest","in":"path","description":"The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records","api_endpoint":"https://api.github.com/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records"},"summary":"List artifact storage records","description":"List artifact storage records with a given subject digest for repositories owned by an organization.\n\nResults are filtered by the authenticated user's permissions; records for repositories the user cannot read are omitted. Fine-grained access tokens require the `artifact-metadata:read` permission.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/attestations/bulk-list":{"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests","api_endpoint":"https://api.github.com/orgs/{org}/attestations/bulk-list"},"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.\n\nThe 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.\n\n**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/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"predicate_type":{"type":"string","description":"Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types."},"subject_digests":{"type":"array","description":"List of subject digests to fetch attestations for.","required":true,"items":{"type":"string"}}}},"example":{"predicate_type":"","subject_digests":[]}}}}}},"/orgs/{org}/attestations/delete-request":{"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk","api_endpoint":"https://api.github.com/orgs/{org}/attestations/delete-request"},"summary":"Delete attestations in bulk","description":"Delete artifact attestations in bulk by either subject digests or unique ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subject_digests":{"type":"array","description":"List of subject digests associated with the artifact attestations to delete.","required":true,"items":{"type":"string"}}}},"example":{"subject_digests":[]}}}}}},"/orgs/{org}/attestations/digest/{subject_digest}":{"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"subject_digest","in":"path","description":"Subject Digest","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest","api_endpoint":"https://api.github.com/orgs/{org}/attestations/digest/{subject_digest}"},"summary":"Delete attestations by subject digest","description":"Delete an artifact attestation by subject digest.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/attestations/repositories":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"predicate_type","in":"query","description":"Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/attestations#list-attestation-repositories","api_endpoint":"https://api.github.com/orgs/{org}/attestations/repositories"},"summary":"List attestation repositories","description":"List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID","security":[{"bearerAuth":[]}]}},"/orgs/{org}/attestations/{attestation_id}":{"delete":{"tags":["Organizations"],"parameters":[{"name":"attestation_id","in":"path","description":"Attestation ID","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id","api_endpoint":"https://api.github.com/orgs/{org}/attestations/{attestation_id}"},"summary":"Delete attestations by ID","description":"Delete an artifact attestation by unique ID that is associated with a repository owned by an org.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/attestations/{subject_digest}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"subject_digest","in":"path","description":"The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"predicate_type","in":"query","description":"Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/attestations#list-attestations","api_endpoint":"https://api.github.com/orgs/{org}/attestations/{subject_digest}"},"summary":"List attestations","description":"List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe 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.\n\n**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/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).","security":[{"bearerAuth":[]}]}},"/orgs/{org}/blocks":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/blocks"},"summary":"List users blocked by an organization","description":"List the users blocked by an organization.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/blocks/{username}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/blocks/{username}"},"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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/blocks/{username}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/blocks/{username}"},"summary":"Unblock a user from an organization","description":"Unblocks the given user on behalf of the specified organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/campaigns":{"get":{"tags":["Campaigns"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property by which to sort the results.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","ends_at","published"]}}},{"name":"state","in":"query","description":"Indicates whether a campaign is open or closed","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/campaigns"},"summary":"List campaigns for an organization","description":"Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Campaigns"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/campaigns"},"summary":"Create a campaign for an organization","description":"Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"code_scanning_alerts":{"type":"array","description":"The code scanning alerts to include in this campaign","items":{"type":"object","properties":{"alert_numbers":{"type":"array","description":"The alert numbers","required":true},"repository_id":{"type":"number","description":"The repository id","required":true}}}},"contact_link":{"type":"string","description":"The contact link of the campaign. Must be a URI."},"description":{"type":"string","description":"A description for the campaign","required":true},"ends_at":{"type":"string","description":"The end date and time of the campaign. The date must be in the future.","required":true},"generate_issues":{"type":"boolean","description":"If true, will automatically generate issues for the campaign. The default is false.","enum":[true,false]},"managers":{"type":"array","description":"The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.","items":{"type":"string"}},"name":{"type":"string","description":"The name of the campaign","required":true},"team_managers":{"type":"array","description":"The slugs of the teams to set as the campaign managers.","items":{"type":"string"}}}},"example":{"code_scanning_alerts":[],"contact_link":"","description":"","ends_at":"","generate_issues":"","managers":[],"name":"","team_managers":[]}}}}}},"/orgs/{org}/campaigns/{campaign_number}":{"get":{"tags":["Campaigns"],"parameters":[{"name":"campaign_number","in":"path","description":"The campaign number.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/campaigns/{campaign_number}"},"summary":"Get a campaign for an organization","description":"Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Campaigns"],"parameters":[{"name":"campaign_number","in":"path","description":"The campaign number.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/campaigns/campaigns#update-a-campaign","api_endpoint":"https://api.github.com/orgs/{org}/campaigns/{campaign_number}"},"summary":"Update a campaign","description":"Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_link":{"type":"string","description":"The contact link of the campaign. Must be a URI."},"description":{"type":"string","description":"A description for the campaign"},"ends_at":{"type":"string","description":"The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."},"managers":{"type":"array","description":"The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.","items":{"type":"string"}},"name":{"type":"string","description":"The name of the campaign"},"state":{"type":"string","description":"Indicates whether a campaign is open or closed","enum":["open","closed"]},"team_managers":{"type":"array","description":"The slugs of the teams to set as the campaign managers.","items":{"type":"string"}}}},"example":{"contact_link":"","description":"","ends_at":"","managers":[],"name":"","state":"","team_managers":[]}}}}},"delete":{"tags":["Campaigns"],"parameters":[{"name":"campaign_number","in":"path","description":"The campaign number.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/campaigns/{campaign_number}"},"summary":"Delete a campaign for an organization","description":"Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/code-scanning/ai-scan":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-the-ai-scan-setting-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/code-scanning/ai-scan"},"summary":"Get the AI Scan setting for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the AI Scan setting stored on an organization.\n\nThe response reports the value stored on the organization. Organization respects enterprise policy.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `repo`, or `write:org` scope to use this endpoint. Organization owners can use `admin:org` or `repo`; security managers need `write:org`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Code Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#update-the-ai-scan-setting-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/code-scanning/ai-scan"},"summary":"Update the AI Scan setting for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates the AI Scan setting stored on an organization.\n\nThe organization respects the enterprise policy, so enabling is rejected when the enterprise disallows AI Scan.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `repo`, or `write:org` scope to use this endpoint. Organization owners can use `admin:org` or `repo`; security managers need `write:org`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pr_scan":{"type":"string","description":"Whether AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.","enum":["enabled","disabled"]}}},"example":{"pr_scan":""}}}}}},"/orgs/{org}/code-scanning/alerts":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"assignees","in":"query","description":"Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.\n","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"severity","in":"query","description":"Severity of a code scanning alert.","schema":{"type":"string","example":"","items":{"type":"string","enum":["critical","high","medium","low","warning","note","error"]}}},{"name":"sort","in":"query","description":"The property by which to sort the results.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}},{"name":"state","in":"query","description":"State of a code scanning alert.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed","dismissed","fixed"]}}},{"name":"tool_guid","in":"query","description":"The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.","schema":{"type":"string","example":""}},{"name":"tool_name","in":"query","description":"The name of the tool used to generate the code scanning analysis.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/code-scanning/alerts"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/code-security/configurations":{"get":{"tags":["Code Security"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"target_type","in":"query","description":"The target type of the code security configuration","schema":{"type":"string","example":"","items":{"type":"string","enum":["global","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations"},"summary":"Get code security configurations for an organization","description":"Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Code Security"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations"},"summary":"Create a code security configuration","description":"Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"advanced_security":{"type":"string","description":"The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `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.\n","enum":["enabled","disabled","code_security","secret_protection"]},"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","properties":{"runner_label":{"type":"string","description":"The label of the runner to use for code scanning default setup when runner_type is 'labeled'."},"runner_type":{"type":"string","description":"Whether to use labeled runners or standard GitHub runners.","enum":["standard","labeled","not_set"]}}},"code_scanning_delegated_alert_dismissal":{"type":"string","description":"The enablement status of code scanning delegated alert dismissal","enum":["enabled","disabled","not_set"]},"code_scanning_options":{"type":"object","description":"Security Configuration feature options for code scanning","properties":{"allow_advanced":{"type":"boolean","description":"Whether to allow repos which use advanced setup","enum":[true,false]}}},"code_security":{"type":"string","description":"The enablement status of GitHub Code Security features.","enum":["enabled","disabled","not_set"]},"dependabot_alerts":{"type":"string","description":"The enablement status of Dependabot alerts","enum":["enabled","disabled","not_set"]},"dependabot_delegated_alert_dismissal":{"type":"string","description":"The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.","enum":["enabled","disabled","not_set"]},"dependabot_security_updates":{"type":"string","description":"The enablement status of Dependabot security updates","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.","enum":[true,false]}}},"description":{"type":"string","description":"A description of the code security configuration"},"enforcement":{"type":"string","description":"The enforcement status for a security configuration","enum":["enforced","unenforced"]},"name":{"type":"string","description":"The name of the code security configuration. Must be unique within the organization.","required":true},"private_vulnerability_reporting":{"type":"string","description":"The enablement status of private vulnerability reporting","enum":["enabled","disabled","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"]},"secret_scanning_delegated_alert_dismissal":{"type":"string","description":"The enablement status of secret scanning delegated alert dismissal","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"}}},"secret_scanning_extended_metadata":{"type":"string","description":"The enablement status of secret scanning extended metadata","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_non_provider_patterns":{"type":"string","description":"The enablement status of secret scanning non provider patterns","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"]}}},"example":{"advanced_security":"","code_scanning_default_setup":"","code_scanning_default_setup_options":{},"code_scanning_delegated_alert_dismissal":"","code_scanning_options":{},"code_security":"","dependabot_alerts":"","dependabot_delegated_alert_dismissal":"","dependabot_security_updates":"","dependency_graph":"","dependency_graph_autosubmit_action":"","dependency_graph_autosubmit_action_options":{},"description":"","enforcement":"","name":"","private_vulnerability_reporting":"","secret_protection":"","secret_scanning":"","secret_scanning_delegated_alert_dismissal":"","secret_scanning_delegated_bypass":"","secret_scanning_delegated_bypass_options":{},"secret_scanning_extended_metadata":"","secret_scanning_generic_secrets":"","secret_scanning_non_provider_patterns":"","secret_scanning_push_protection":"","secret_scanning_validity_checks":""}}}}}},"/orgs/{org}/code-security/configurations/defaults":{"get":{"tags":["Code Security"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations/defaults"},"summary":"Get default code security configurations","description":"Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/code-security/configurations/detach":{"delete":{"tags":["Code Security"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations/detach"},"summary":"Detach configurations from repositories","description":"Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_repository_ids":{"type":"array","description":"An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/code-security/configurations/{configuration_id}":{"get":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations/{configuration_id}"},"summary":"Get a code security configuration","description":"Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations/{configuration_id}"},"summary":"Update a code security configuration","description":"Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"advanced_security":{"type":"string","description":"The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `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.\n","enum":["enabled","disabled","code_security","secret_protection"]},"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","properties":{"runner_label":{"type":"string","description":"The label of the runner to use for code scanning default setup when runner_type is 'labeled'."},"runner_type":{"type":"string","description":"Whether to use labeled runners or standard GitHub runners.","enum":["standard","labeled","not_set"]}}},"code_scanning_delegated_alert_dismissal":{"type":"string","description":"The enablement status of code scanning delegated alert dismissal","enum":["enabled","disabled","not_set"]},"code_scanning_options":{"type":"object","description":"Security Configuration feature options for code scanning","properties":{"allow_advanced":{"type":"boolean","description":"Whether to allow repos which use advanced setup","enum":[true,false]}}},"code_security":{"type":"string","description":"The enablement status of GitHub Code Security features.","enum":["enabled","disabled","not_set"]},"dependabot_alerts":{"type":"string","description":"The enablement status of Dependabot alerts","enum":["enabled","disabled","not_set"]},"dependabot_delegated_alert_dismissal":{"type":"string","description":"The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.","enum":["enabled","disabled","not_set"]},"dependabot_security_updates":{"type":"string","description":"The enablement status of Dependabot security updates","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.","enum":[true,false]}}},"description":{"type":"string","description":"A description of the code security configuration"},"enforcement":{"type":"string","description":"The enforcement status for a security configuration","enum":["enforced","unenforced"]},"name":{"type":"string","description":"The name of the code security configuration. Must be unique within the organization."},"private_vulnerability_reporting":{"type":"string","description":"The enablement status of private vulnerability reporting","enum":["enabled","disabled","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"]},"secret_scanning_delegated_alert_dismissal":{"type":"string","description":"The enablement status of secret scanning delegated alert dismissal","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"}}},"secret_scanning_extended_metadata":{"type":"string","description":"The enablement status of secret scanning extended metadata","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_non_provider_patterns":{"type":"string","description":"The enablement status of secret scanning non-provider patterns","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"]}}},"example":{"advanced_security":"","code_scanning_default_setup":"","code_scanning_default_setup_options":{},"code_scanning_delegated_alert_dismissal":"","code_scanning_options":{},"code_security":"","dependabot_alerts":"","dependabot_delegated_alert_dismissal":"","dependabot_security_updates":"","dependency_graph":"","dependency_graph_autosubmit_action":"","dependency_graph_autosubmit_action_options":{},"description":"","enforcement":"","name":"","private_vulnerability_reporting":"","secret_protection":"","secret_scanning":"","secret_scanning_delegated_alert_dismissal":"","secret_scanning_delegated_bypass":"","secret_scanning_delegated_bypass_options":{},"secret_scanning_extended_metadata":"","secret_scanning_generic_secrets":"","secret_scanning_non_provider_patterns":"","secret_scanning_push_protection":"","secret_scanning_validity_checks":""}}}}},"delete":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations/{configuration_id}"},"summary":"Delete a code security configuration","description":"Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/code-security/configurations/{configuration_id}/attach":{"post":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations/{configuration_id}/attach"},"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.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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`","required":true,"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":"number"}}}},"example":{"scope":"","selected_repository_ids":[]}}}}}},"/orgs/{org}/code-security/configurations/{configuration_id}/defaults":{"put":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations/{configuration_id}/defaults"},"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.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"]}}},"example":{"default_for_new_repos":""}}}}}},"/orgs/{org}/code-security/configurations/{configuration_id}/repositories":{"get":{"tags":["Code Security"],"parameters":[{"name":"configuration_id","in":"path","description":"The unique identifier of the code security configuration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration","api_endpoint":"https://api.github.com/orgs/{org}/code-security/configurations/{configuration_id}/repositories"},"summary":"Get repositories associated with a code security configuration","description":"Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/codespaces":{"get":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization","api_endpoint":"https://api.github.com/orgs/{org}/codespaces"},"summary":"List codespaces for the organization","description":"Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/codespaces/access":{"put":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/access"},"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.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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"}},"visibility":{"type":"string","description":"Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.","required":true,"enum":["disabled","selected_members","all_members","all_members_and_outside_collaborators"]}}},"example":{"selected_usernames":[],"visibility":""}}}}}},"/orgs/{org}/codespaces/access/selected_users":{"post":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/access/selected_users"},"summary":"Add users to Codespaces access for an organization","description":"Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_usernames":{"type":"array","description":"The usernames of the organization members and outside collaborators whose codespaces should be billed to the organization.","required":true,"items":{"type":"string"}}}},"example":{"selected_usernames":[]}}}}},"delete":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/access/selected_users"},"summary":"Remove users from Codespaces access for an organization","description":"Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_usernames":{"type":"array","description":"The usernames of the organization members and outside collaborators whose codespaces should not be billed to the organization.","required":true,"items":{"type":"string"}}}},"example":{"selected_usernames":[]}}}}}},"/orgs/{org}/codespaces/secrets":{"get":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets"},"summary":"List organization secrets","description":"Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/codespaces/secrets/public-key":{"get":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets/public-key"},"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.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/codespaces/secrets/{secret_name}":{"get":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets/{secret_name}"},"summary":"Get an organization secret","description":"Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets/{secret_name}"},"summary":"Create or update an organization secret","description":"Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint."},"key_id":{"type":"string","description":"The 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 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/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.","items":{"type":"number"}},"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.","required":true,"enum":["all","private","selected"]}}},"example":{"encrypted_value":"","key_id":"","selected_repository_ids":[],"visibility":""}}}}},"delete":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets/{secret_name}"},"summary":"Delete an organization secret","description":"Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/codespaces/secrets/{secret_name}/repositories":{"get":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets/{secret_name}/repositories"},"summary":"List selected repositories for an organization secret","description":"Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets/{secret_name}/repositories"},"summary":"Set selected repositories for an organization secret","description":"Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}":{"put":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"},"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/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Remove selected repository from an organization secret","description":"Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/copilot-spaces":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.","schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 100).","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-organization-copilot-spaces","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces"},"summary":"List organization Copilot Spaces","description":"Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.","security":[{"bearerAuth":[]}]},"post":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces"},"summary":"Create an organization Copilot Space","description":"Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"base_role":{"type":"string","description":"The base role that determines default permissions for organization members.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space","enum":["reader","writer","admin","no_access"]},"description":{"type":"string","description":"A description of the Copilot Space."},"general_instructions":{"type":"string","description":"General instructions for the Copilot Space."},"name":{"type":"string","description":"The name of the Copilot Space.","required":true},"resources_attributes":{"type":"array","description":"Resources to attach to the space.","items":{"type":"object","properties":{"metadata":{"type":"object","description":"Metadata specific to the resource type."},"resource_type":{"type":"string","description":"The type of resource.","enum":["repository","github_file","free_text","github_issue","github_pull_request","media_content","uploaded_text_file"]}}}}}},"example":{"base_role":"","description":"","general_instructions":"","name":"","resources_attributes":[]}}}}}},"/orgs/{org}/copilot-spaces/{space_number}":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}"},"summary":"Get an organization Copilot Space","description":"Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}]},"put":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}"},"summary":"Set an organization Copilot Space","description":"Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"base_role":{"type":"string","description":"The base role that determines default permissions for organization members. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Organization members can read the space\n- `writer`: Organization members can read and edit the space\n- `admin`: Organization members have full admin access to the space","enum":["reader","writer","admin","no_access"]},"description":{"type":"string","description":"A description of the Copilot Space."},"general_instructions":{"type":"string","description":"General instructions for the Copilot Space."},"name":{"type":"string","description":"The name of the Copilot Space."},"resources_attributes":{"type":"array","description":"Resources to attach to the space.","items":{"type":"object","properties":{"metadata":{"type":"object","description":"Metadata specific to the resource type."},"resource_type":{"type":"string","description":"The type of resource.","enum":["repository","github_file","free_text","github_issue","github_pull_request","media_content","uploaded_text_file"]}}}}}},"example":{"base_role":"","description":"","general_instructions":"","name":"","resources_attributes":[]}}}}},"delete":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}"},"summary":"Delete an organization Copilot Space","description":"Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/copilot-spaces/{space_number}/collaborators":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/collaborators"},"summary":"List collaborators for an organization Copilot Space","description":"Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}]},"post":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/collaborators"},"summary":"Add a collaborator to an organization Copilot Space","description":"Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"actor_identifier":{"type":"string","description":"The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.","required":true},"actor_type":{"type":"string","description":"The type of actor (user or team).","required":true,"enum":["User","Team"]},"role":{"type":"string","description":"The role to grant to the collaborator.","required":true,"enum":["reader","writer","admin"]}}},"example":{"actor_identifier":"","actor_type":"","role":""}}}}}},"/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}":{"put":{"tags":["Copilot Spaces"],"parameters":[{"name":"actor_identifier","in":"path","description":"The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.","required":true,"schema":{"type":"string","example":""}},{"name":"actor_type","in":"path","description":"The type of actor (user or team).","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["User","Team"]}}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}"},"summary":"Set a collaborator role for an organization Copilot Space","description":"Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"role":{"type":"string","description":"The new role to grant to the collaborator. Use `no_access` to remove the collaborator.","required":true,"enum":["reader","writer","admin","no_access"]}}},"example":{"role":""}}}}},"delete":{"tags":["Copilot Spaces"],"parameters":[{"name":"actor_identifier","in":"path","description":"The username (for users) or team slug (for teams). The numeric ID of a user or team is also accepted.","required":true,"schema":{"type":"string","example":""}},{"name":"actor_type","in":"path","description":"The type of actor (user or team).","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["User","Team"]}}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}"},"summary":"Remove a collaborator from an organization Copilot Space","description":"Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/copilot-spaces/{space_number}/resources":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/resources"},"summary":"List resources for an organization Copilot Space","description":"Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}]},"post":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/resources"},"summary":"Create a resource for an organization Copilot Space","description":"Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"metadata":{"type":"object","description":"Resource-specific metadata.","required":true,"properties":{}},"resource_type":{"type":"string","description":"The type of resource to create.","required":true,"enum":["repository","github_file","free_text","github_issue","github_pull_request"]}}},"example":{"metadata":{},"resource_type":""}}}}}},"/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"space_resource_id","in":"path","description":"The unique identifier of the resource.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}"},"summary":"Get a resource for an organization Copilot Space","description":"Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}]},"put":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"space_resource_id","in":"path","description":"The unique identifier of the resource.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}"},"summary":"Set a resource for an organization Copilot Space","description":"Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"metadata":{"type":"object","description":"Updated resource-specific metadata.","properties":{}}}},"example":{"metadata":{}}}}}},"delete":{"tags":["Copilot Spaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"space_resource_id","in":"path","description":"The unique identifier of the resource.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-an-organization-copilot-space","api_endpoint":"https://api.github.com/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}"},"summary":"Delete a resource from an organization Copilot Space","description":"Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/copilot/billing":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/billing"},"summary":"Get Copilot seat information and settings for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/copilot/billing/seats":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/billing/seats"},"summary":"List all Copilot seat assignments for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach 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`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/copilot/billing/selected_teams":{"post":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/billing/selected_teams"},"summary":"Add teams to the Copilot subscription for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe 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/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly 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.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/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).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_teams":{"type":"array","description":"List of team names within the organization to which to grant access to GitHub Copilot.","required":true,"items":{"type":"string"}}}},"example":{"selected_teams":[]}}}}},"delete":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/billing/selected_teams"},"summary":"Remove teams from the Copilot subscription for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis 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.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/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).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_teams":{"type":"array","description":"The names of teams from which to revoke access to GitHub Copilot.","required":true,"items":{"type":"string"}}}},"example":{"selected_teams":[]}}}}}},"/orgs/{org}/copilot/billing/selected_users":{"post":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/billing/selected_users"},"summary":"Add users to the Copilot subscription for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe 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/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly 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.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/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).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_usernames":{"type":"array","description":"The usernames of the organization members to be granted access to GitHub Copilot.","required":true,"items":{"type":"string"}}}},"example":{"selected_usernames":[]}}}}},"delete":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/billing/selected_users"},"summary":"Remove users from the Copilot subscription for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis 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.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/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).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_usernames":{"type":"array","description":"The usernames of the organization members for which to revoke access to GitHub Copilot.","required":true,"items":{"type":"string"}}}},"example":{"selected_usernames":[]}}}}}},"/orgs/{org}/copilot/coding-agent/permissions":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-cloud-agent-permissions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/coding-agent/permissions"},"summary":"Get Copilot cloud agent permissions for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-cloud-agent-permissions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/coding-agent/permissions"},"summary":"Set Copilot cloud agent permissions for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot cloud agent.\n\nOrganization owners can configure whether Copilot cloud agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enabled_repositories":{"type":"string","description":"The policy for which repositories can use Copilot cloud agent. Can be one of `all`, `selected`, or `none`.","required":true,"enum":["all","selected","none"]}}},"example":{"enabled_repositories":""}}}}}},"/orgs/{org}/copilot/coding-agent/permissions/repositories":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-cloud-agent-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/coding-agent/permissions/repositories"},"summary":"List repositories enabled for Copilot cloud agent in an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot cloud agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-cloud-agent-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/coding-agent/permissions/repositories"},"summary":"Set selected repositories for Copilot cloud agent in an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot cloud\nagent in an organization. This method can only be called when the cloud agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"selected_repository_ids":{"type":"array","description":"List of repository IDs to enable for Copilot cloud agent.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}":{"put":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-cloud-agent-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}"},"summary":"Enable a repository for Copilot cloud agent in an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-cloud-agent-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}"},"summary":"Disable a repository for Copilot cloud agent in an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncloud agent in an organization. This method can only be called when the\ncloud agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/copilot/content_exclusion":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/content_exclusion"},"summary":"Get Copilot content exclusion rules for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.","security":[{"bearerAuth":[]}]},"put":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/copilot/content_exclusion"},"summary":"Set Copilot content exclusion rules for an organization","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/copilot/metrics/reports/organization-1-day":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"The day to request data for, in `YYYY-MM-DD` format.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day","api_endpoint":"https://api.github.com/orgs/{org}/copilot/metrics/reports/organization-1-day"},"summary":"Get Copilot organization usage metrics for a specific day","description":"Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe 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.\n\nThe 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.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).","security":[{"bearerAuth":[]}]}},"/orgs/{org}/copilot/metrics/reports/organization-28-day/latest":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics","api_endpoint":"https://api.github.com/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"},"summary":"Get Copilot organization usage metrics","description":"Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe 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.\n\nThe 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.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).","security":[{"bearerAuth":[]}]}},"/orgs/{org}/copilot/metrics/reports/repos-1-day":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"The day to request data for, in `YYYY-MM-DD` format.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-repository-report-for-a-specific-day","api_endpoint":"https://api.github.com/orgs/{org}/copilot/metrics/reports/repos-1-day"},"summary":"Get Copilot organization repository report for a specific day","description":"Use this endpoint to retrieve download links for the Copilot organization repository report for a specific day. The report provides per-repository pull request metrics for Copilot across the organization, with one entry per repository.\n\nThe report contains repository-level pull request activity for the specified day, including the Copilot Coding Agent (CCA) and Copilot Code Review (CCR) breakdowns. Only repositories that had activity on the specified day are included. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe 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.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).","security":[{"bearerAuth":[]}]}},"/orgs/{org}/copilot/metrics/reports/user-teams-1-day":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"The day to request data for, in `YYYY-MM-DD` format.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day","api_endpoint":"https://api.github.com/orgs/{org}/copilot/metrics/reports/user-teams-1-day"},"summary":"Get Copilot organization user-teams report for a specific day","description":"Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe 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.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).","security":[{"bearerAuth":[]}]}},"/orgs/{org}/copilot/metrics/reports/users-1-day":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"The day to request data for, in `YYYY-MM-DD` format.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day","api_endpoint":"https://api.github.com/orgs/{org}/copilot/metrics/reports/users-1-day"},"summary":"Get Copilot organization users usage metrics for a specific day","description":"Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe 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.\n\nReports 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.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).","security":[{"bearerAuth":[]}]}},"/orgs/{org}/copilot/metrics/reports/users-28-day/latest":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics","api_endpoint":"https://api.github.com/orgs/{org}/copilot/metrics/reports/users-28-day/latest"},"summary":"Get Copilot organization users usage metrics","description":"Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe 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.\n\nReports 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.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).","security":[{"bearerAuth":[]}]}},"/orgs/{org}/dependabot/alerts":{"get":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"artifact_registry","in":"query","description":"A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`","schema":{"type":"string","example":""}},{"name":"artifact_registry_url","in":"query","description":"A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.","schema":{"type":"string","example":""}},{"name":"assignee","in":"query","description":"Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"classification","in":"query","description":"A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"ecosystem","in":"query","description":"A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`","schema":{"type":"string","example":""}},{"name":"epss_percentage","in":"query","description":"CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.","schema":{"type":"string","example":""}},{"name":"first","in":"query","description":"**Deprecated**","schema":{"type":"number","example":""}},{"name":"has","in":"query","description":"Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.","schema":{"type":"string","example":""}},{"name":"last","in":"query","description":"**Deprecated**","schema":{"type":"number","example":""}},{"name":"package","in":"query","description":"A comma-separated list of package names. If specified, only alerts for these packages will be returned.","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"relationship","in":"query","description":"A comma-separated list of relationships of the vulnerable dependency to your project. If specified, only alerts with these relationships will be returned.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.","schema":{"type":"string","example":""}},{"name":"runtime_risk","in":"query","description":"A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`","schema":{"type":"string","example":""}},{"name":"scope","in":"query","description":"The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["development","runtime"]}}},{"name":"severity","in":"query","description":"A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","epss_percentage"]}}},{"name":"state","in":"query","description":"A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/alerts"},"summary":"List Dependabot alerts for an organization","description":"Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/dependabot/repository-access":{"get":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of results to fetch.","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of results per page.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/repository-access"},"summary":"Lists the repositories Dependabot can access in an organization","description":"Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n>    This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/repository-access"},"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.\n\n> [!NOTE]\n>    This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n  \"repository_ids_to_add\": [123, 456],\n  \"repository_ids_to_remove\": [789]\n}\n```","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"repository_ids_to_add":{"type":"array","description":"List of repository IDs to add.","items":{"type":"number"}},"repository_ids_to_remove":{"type":"array","description":"List of repository IDs to remove.","items":{"type":"number"}}}},"example":{"repository_ids_to_add":[],"repository_ids_to_remove":[]}}}}}},"/orgs/{org}/dependabot/repository-access/default-level":{"put":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/repository-access/default-level"},"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:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"default_level":{"type":"string","description":"The default repository access level for Dependabot updates.","required":true,"enum":["public","internal"]}}},"example":{"default_level":""}}}}}},"/orgs/{org}/dependabot/secrets":{"get":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#list-organization-secrets","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets"},"summary":"List organization secrets","description":"Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/dependabot/secrets/public-key":{"get":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets/public-key"},"summary":"Get an organization public key","description":"Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/dependabot/secrets/{secret_name}":{"get":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets/{secret_name}"},"summary":"Get an organization secret","description":"Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets/{secret_name}"},"summary":"Create or update an organization secret","description":"Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/dependabot/secrets#get-an-organization-public-key) endpoint."},"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 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/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.","items":{"type":"number"}},"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.","required":true,"enum":["all","private","selected"]}}},"example":{"encrypted_value":"","key_id":"","selected_repository_ids":[],"visibility":""}}}}},"delete":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets/{secret_name}"},"summary":"Delete an organization secret","description":"Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/dependabot/secrets/{secret_name}/repositories":{"get":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets/{secret_name}/repositories"},"summary":"List selected repositories for an organization secret","description":"Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets/{secret_name}/repositories"},"summary":"Set selected repositories for an organization secret","description":"Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}":{"put":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Add selected repository to an organization secret","description":"Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Dependabot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret","api_endpoint":"https://api.github.com/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Remove selected repository from an organization secret","description":"Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/docker/conflicts":{"get":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization","api_endpoint":"https://api.github.com/orgs/{org}/docker/conflicts"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/events":{"get":{"tags":["Activity"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-public-organization-events","api_endpoint":"https://api.github.com/orgs/{org}/events"},"summary":"List public organization events","description":"> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/failed_invitations":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#list-failed-organization-invitations","api_endpoint":"https://api.github.com/orgs/{org}/failed_invitations"},"summary":"List failed organization invitations","description":"The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/hooks":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks","api_endpoint":"https://api.github.com/orgs/{org}/hooks"},"summary":"List organization webhooks","description":"List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}]},"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook","api_endpoint":"https://api.github.com/orgs/{org}/hooks"},"summary":"Create an organization webhook","description":"Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","enum":[true,false]},"config":{"type":"object","description":"Key/value pairs to provide settings for this webhook.","required":true,"properties":{"content_type":{"type":"string","description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."},"insecure_ssl":{"type":"string","description":"insecure_ssl"},"password":{"type":"string","description":"password"},"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/webhooks/event-payloads/#delivery-headers)."},"url":{"type":"string","description":"The URL to which the payloads will be delivered.","required":true},"username":{"type":"string","description":"username"}}},"events":{"type":"array","description":"Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.","items":{"type":"string"}},"name":{"type":"string","description":"Must be passed as \"web\".","required":true}}},"example":{"active":"","config":{},"events":[],"name":""}}}}}},"/orgs/{org}/hooks/{hook_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}"},"summary":"Get an organization webhook","description":"Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Organizations"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}"},"summary":"Update an organization webhook","description":"Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","enum":[true,false]},"config":{"type":"object","description":"Key/value pairs to provide settings for this webhook.","properties":{"content_type":{"type":"string","description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."},"insecure_ssl":{"type":"string","description":"insecure_ssl"},"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/webhooks/event-payloads/#delivery-headers)."},"url":{"type":"string","description":"The URL to which the payloads will be delivered.","required":true}}},"events":{"type":"array","description":"Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.","items":{"type":"string"}},"name":{"type":"string","description":"name"}}},"example":{"active":"","config":{},"events":[],"name":""}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}"},"summary":"Delete an organization webhook","description":"Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/hooks/{hook_id}/config":{"get":{"tags":["Organizations"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}/config"},"summary":"Get a webhook configuration for an organization","description":"Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Organizations"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}/config"},"summary":"Update a webhook configuration for an organization","description":"Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content_type":{"type":"string","description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."},"insecure_ssl":{"type":"string","description":"insecure_ssl"},"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/webhooks/event-payloads/#delivery-headers)."},"url":{"type":"string","description":"The URL to which the payloads will be delivered."}}},"example":{"content_type":"","insecure_ssl":"","secret":"","url":""}}}}}},"/orgs/{org}/hooks/{hook_id}/deliveries":{"get":{"tags":["Organizations"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"redelivery","in":"query","description":"redelivery","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"status","in":"query","description":"Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).","schema":{"type":"string","example":"","items":{"type":"string","enum":["success","failure"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}/deliveries"},"summary":"List deliveries for an organization webhook","description":"Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"delivery_id","in":"path","description":"delivery_id","required":true,"schema":{"type":"number","example":""}},{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}"},"summary":"Get a webhook delivery for an organization webhook","description":"Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts":{"post":{"tags":["Organizations"],"parameters":[{"name":"delivery_id","in":"path","description":"delivery_id","required":true,"schema":{"type":"number","example":""}},{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"},"summary":"Redeliver a delivery for an organization webhook","description":"Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/hooks/{hook_id}/pings":{"post":{"tags":["Organizations"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook","api_endpoint":"https://api.github.com/orgs/{org}/hooks/{hook_id}/pings"},"summary":"Ping an organization webhook","description":"This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"actor_id","in":"path","description":"The ID of the actor","required":true,"schema":{"type":"number","example":""}},{"name":"actor_type","in":"path","description":"The type of the actor","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["installation","classic_pat","fine_grained_pat","oauth_app","github_app_user_to_server"]}}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"api_route_substring","in":"query","description":"Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}"},"summary":"Get route stats by actor","description":"Get API request count statistics for an actor broken down by route within a specified time frame.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/insights/api/subject-stats":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"array","example":""}},{"name":"subject_name_substring","in":"query","description":"Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-subject-stats","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/subject-stats"},"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.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/insights/api/summary-stats":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-summary-stats","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/summary-stats"},"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.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/insights/api/summary-stats/users/{user_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"user_id","in":"path","description":"The ID of the user to query for stats","required":true,"schema":{"type":"string","example":""}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/summary-stats/users/{user_id}"},"summary":"Get summary stats by user","description":"Get overall statistics of API requests within the organization for a user.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"actor_id","in":"path","description":"The ID of the actor","required":true,"schema":{"type":"number","example":""}},{"name":"actor_type","in":"path","description":"The type of the actor","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["installation","classic_pat","fine_grained_pat","oauth_app","github_app_user_to_server"]}}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}"},"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.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/insights/api/time-stats":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}},{"name":"timestamp_increment","in":"query","description":"The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-time-stats","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/time-stats"},"summary":"Get time stats","description":"Get the number of API requests and rate-limited requests made within an organization over a specified time period.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/insights/api/time-stats/users/{user_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"user_id","in":"path","description":"The ID of the user to query for stats","required":true,"schema":{"type":"string","example":""}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}},{"name":"timestamp_increment","in":"query","description":"The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/time-stats/users/{user_id}"},"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.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"actor_id","in":"path","description":"The ID of the actor","required":true,"schema":{"type":"number","example":""}},{"name":"actor_type","in":"path","description":"The type of the actor","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["installation","classic_pat","fine_grained_pat","oauth_app","github_app_user_to_server"]}}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}},{"name":"timestamp_increment","in":"query","description":"The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}"},"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.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/insights/api/user-stats/{user_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"user_id","in":"path","description":"The ID of the user to query for stats","required":true,"schema":{"type":"string","example":""}},{"name":"actor_name_substring","in":"query","description":"Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"max_timestamp","in":"query","description":"The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"min_timestamp","in":"query","description":"The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/api-insights#get-user-stats","api_endpoint":"https://api.github.com/orgs/{org}/insights/api/user-stats/{user_id}"},"summary":"Get user stats","description":"Get API usage statistics within an organization for a user broken down by the type of access.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/installation":{"get":{"tags":["Apps"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app","api_endpoint":"https://api.github.com/orgs/{org}/installation"},"summary":"Get an organization installation for the authenticated app","description":"Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/installations":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/installations"},"summary":"List app installations for an organization","description":"Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/interaction-limits":{"get":{"tags":["Interactions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/interaction-limits"},"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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Interactions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/interaction-limits"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"expiry":{"type":"string","description":"The duration of the interaction restriction. Default: `one_day`.","enum":["one_day","three_days","one_week","one_month","six_months"]},"limit":{"type":"string","description":"The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.","required":true,"enum":["existing_users","contributors_only","collaborators_only"]}}},"example":{"expiry":"","limit":""}}}}},"delete":{"tags":["Interactions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/interaction-limits"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/interaction-limits/pulls/creation-cap":{"get":{"tags":["Interactions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/orgs#get-pull-request-creation-cap-for-an-org","api_endpoint":"https://api.github.com/orgs/{org}/interaction-limits/pulls/creation-cap"},"summary":"Get pull request creation cap for an org","description":"Gets the pull request creation cap configuration for an organization.\nThe cap limits the total number of open pull requests a user can have across all public\nrepositories in the organization at one time.\n\nOnly users with admin access to the organization can view the cap configuration.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Interactions"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/orgs#update-pull-request-creation-cap-for-an-org","api_endpoint":"https://api.github.com/orgs/{org}/interaction-limits/pulls/creation-cap"},"summary":"Update pull request creation cap for an org","description":"Updates the pull request creation cap for an organization. The cap limits the total number\nof open pull requests a user can have across all public repositories in the organization\nat one time.\n\nOnly users with admin access to the organization can configure the cap.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enabled":{"type":"boolean","description":"Whether the pull request creation cap is enabled","required":true,"enum":[true,false]},"max_open_pull_requests":{"type":"number","description":"The maximum number of open pull requests a user can have at one time"}}},"example":{"enabled":"","max_open_pull_requests":""}}}}}},"/orgs/{org}/invitations":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"invitation_source","in":"query","description":"Filter invitations by their invitation source.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","member","scim"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"role","in":"query","description":"Filter invitations by their member role.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","admin","direct_member","billing_manager","hiring_manager"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#list-pending-organization-invitations","api_endpoint":"https://api.github.com/orgs/{org}/invitations"},"summary":"List pending organization invitations","description":"The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub\nmember, the `login` field in the return hash will be `null`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#create-an-organization-invitation","api_endpoint":"https://api.github.com/orgs/{org}/invitations"},"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.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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."},"invitee_id":{"type":"number","description":"**Required unless you provide `email`**. GitHub user ID for the person you are inviting."},"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"]},"team_ids":{"type":"array","description":"Specify IDs for the teams you want to invite new members to.","items":{"type":"number"}}}},"example":{"email":"","invitee_id":"","role":"","team_ids":[]}}}}}},"/orgs/{org}/invitations/{invitation_id}":{"delete":{"tags":["Organizations"],"parameters":[{"name":"invitation_id","in":"path","description":"The unique identifier of the invitation.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation","api_endpoint":"https://api.github.com/orgs/{org}/invitations/{invitation_id}"},"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.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/invitations/{invitation_id}/teams":{"get":{"tags":["Organizations"],"parameters":[{"name":"invitation_id","in":"path","description":"The unique identifier of the invitation.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#list-organization-invitation-teams","api_endpoint":"https://api.github.com/orgs/{org}/invitations/{invitation_id}/teams"},"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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/issue-fields":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/issue-fields#list-issue-fields-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/issue-fields"},"summary":"List issue fields for an organization","description":"Lists all issue fields for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/issue-fields#create-issue-field-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/issue-fields"},"summary":"Create issue field for an organization","description":"Creates a new issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data_type":{"type":"string","description":"The data type of the issue field.","required":true,"enum":["text","date","single_select","multi_select","number"]},"description":{"type":"string","description":"Description of the issue field."},"name":{"type":"string","description":"Name of the issue field.","required":true},"options":{"type":"array","description":"Options for select fields. Required when data_type is 'single_select' or 'multi_select'.","items":{"type":"object","properties":{"color":{"type":"string","description":"Color for the option.","required":true,"enum":["gray","blue","green","yellow","orange","red","pink","purple"]},"description":{"type":"string","description":"Description of the option."},"name":{"type":"string","description":"Name of the option.","required":true},"priority":{"type":"number","description":"Priority of the option for ordering.","required":true}}}},"visibility":{"type":"string","description":"The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to `organization_members_only`.","enum":["organization_members_only","all"]}}},"example":{"data_type":"","description":"","name":"","options":[],"visibility":""}}}}}},"/orgs/{org}/issue-fields/{issue_field_id}":{"patch":{"tags":["Organizations"],"parameters":[{"name":"issue_field_id","in":"path","description":"The unique identifier of the issue field.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/issue-fields/{issue_field_id}"},"summary":"Update issue field for an organization","description":"Updates an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description of the issue field."},"name":{"type":"string","description":"Name of the issue field."},"options":{"type":"array","description":"Options for select fields. Only applicable when updating single_select or multi_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.","items":{"type":"object","properties":{"color":{"type":"string","description":"Color for the option.","required":true,"enum":["gray","blue","green","yellow","orange","red","pink","purple"]},"description":{"type":"string","description":"Description of the option."},"id":{"type":"number","description":"The id of an existing option to retain or update. Omit this when creating a new option."},"name":{"type":"string","description":"Name of the option.","required":true},"priority":{"type":"number","description":"Priority of the option for ordering.","required":true}}}},"visibility":{"type":"string","description":"The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled.","enum":["organization_members_only","all"]}}},"example":{"description":"","name":"","options":[],"visibility":""}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"issue_field_id","in":"path","description":"The unique identifier of the issue field.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/issue-fields/{issue_field_id}"},"summary":"Delete issue field for an organization","description":"Deletes an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/issue-types":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/issue-types"},"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.","security":[{"bearerAuth":[]}]},"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/issue-types"},"summary":"Create issue type for an organization","description":"Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"color":{"type":"string","description":"Color for the issue type.","enum":["gray","blue","green","yellow","orange","red","pink","purple"]},"description":{"type":"string","description":"Description of the issue type."},"is_enabled":{"type":"boolean","description":"Whether or not the issue type is enabled at the organization level.","required":true,"enum":[true,false]},"name":{"type":"string","description":"Name of the issue type.","required":true}}},"example":{"color":"","description":"","is_enabled":"","name":""}}}}}},"/orgs/{org}/issue-types/{issue_type_id}":{"put":{"tags":["Organizations"],"parameters":[{"name":"issue_type_id","in":"path","description":"The unique identifier of the issue type.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/issue-types/{issue_type_id}"},"summary":"Update issue type for an organization","description":"Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"color":{"type":"string","description":"Color for the issue type.","enum":["gray","blue","green","yellow","orange","red","pink","purple"]},"description":{"type":"string","description":"Description of the issue type."},"is_enabled":{"type":"boolean","description":"Whether or not the issue type is enabled at the organization level.","required":true,"enum":[true,false]},"name":{"type":"string","description":"Name of the issue type.","required":true}}},"example":{"color":"","description":"","is_enabled":"","name":""}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"issue_type_id","in":"path","description":"The unique identifier of the issue type.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/issue-types/{issue_type_id}"},"summary":"Delete issue type for an organization","description":"Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/issues":{"get":{"tags":["Issues"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"Can be the name of an issue type.","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"filter","in":"query","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.","schema":{"type":"string","example":"","items":{"type":"string","enum":["assigned","created","mentioned","subscribed","repos","all"]}}},{"name":"labels","in":"query","description":"A list of comma separated label names. Example: `bug,ui,@high`","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"What to sort results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","comments"]}}},{"name":"state","in":"query","description":"Indicates the state of the issues to return.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user","api_endpoint":"https://api.github.com/orgs/{org}/issues"},"summary":"List organization issues assigned to the authenticated user","description":"List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> 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/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/members":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"filter","in":"query","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/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.","schema":{"type":"string","example":"","items":{"type":"string","enum":["2fa_disabled","2fa_insecure","all"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"role","in":"query","description":"Filter members returned by their role.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","admin","member"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#list-organization-members","api_endpoint":"https://api.github.com/orgs/{org}/members"},"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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/members/{username}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/members/{username}"},"summary":"Check organization membership for a user","description":"Check if a user is, publicly or privately, a member of the organization.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#remove-an-organization-member","api_endpoint":"https://api.github.com/orgs/{org}/members/{username}"},"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.\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/members/{username}/codespaces":{"get":{"tags":["Codespaces"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization","api_endpoint":"https://api.github.com/orgs/{org}/members/{username}/codespaces"},"summary":"List codespaces for a user in organization","description":"Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/members/{username}/codespaces/{codespace_name}":{"delete":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization","api_endpoint":"https://api.github.com/orgs/{org}/members/{username}/codespaces/{codespace_name}"},"summary":"Delete a codespace from the organization","description":"Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop":{"post":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user","api_endpoint":"https://api.github.com/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop"},"summary":"Stop a codespace for an organization user","description":"Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/members/{username}/copilot":{"get":{"tags":["Copilot"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/members/{username}/copilot"},"summary":"Get Copilot seat assignment details for a user","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe 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`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/memberships/{username}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/memberships/{username}"},"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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/memberships/{username}"},"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/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"]}}},"example":{"role":""}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/memberships/{username}"},"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.\n\nIf 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.\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/migrations":{"get":{"tags":["Migrations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"exclude","in":"query","description":"Exclude attributes from the API response to improve performance","schema":{"type":"array","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/orgs#list-organization-migrations","api_endpoint":"https://api.github.com/orgs/{org}/migrations"},"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).\n\nA list of `repositories` is only returned for export migrations.","security":[{"bearerAuth":[]}]},"post":{"tags":["Migrations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/orgs#start-an-organization-migration","api_endpoint":"https://api.github.com/orgs/{org}/migrations"},"summary":"Start an organization migration","description":"Initiates the generation of a migration archive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"exclude":{"type":"array","description":"Exclude related items from being returned in the response in order to improve performance of the request.","items":{"type":"string"}},"exclude_attachments":{"type":"boolean","description":"Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).","enum":[true,false]},"exclude_git_data":{"type":"boolean","description":"Indicates whether the repository git data should be excluded from the migration.","enum":[true,false]},"exclude_metadata":{"type":"boolean","description":"Indicates whether metadata should be excluded and only git source should be included for the migration.","enum":[true,false]},"exclude_owner_projects":{"type":"boolean","description":"Indicates whether projects owned by the organization or users should be excluded. from the migration.","enum":[true,false]},"exclude_releases":{"type":"boolean","description":"Indicates whether releases should be excluded from the migration (to reduce migration archive file size).","enum":[true,false]},"lock_repositories":{"type":"boolean","description":"Indicates whether repositories should be locked (to prevent manipulation) while migrating data.","enum":[true,false]},"org_metadata_only":{"type":"boolean","description":"Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).","enum":[true,false]},"repositories":{"type":"array","description":"A list of arrays indicating which repositories should be migrated.","required":true,"items":{"type":"string"}}}},"example":{"exclude":[],"exclude_attachments":"","exclude_git_data":"","exclude_metadata":"","exclude_owner_projects":"","exclude_releases":"","lock_repositories":"","org_metadata_only":"","repositories":[]}}}}}},"/orgs/{org}/migrations/{migration_id}":{"get":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"exclude","in":"query","description":"Exclude attributes from the API response to improve performance","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status","api_endpoint":"https://api.github.com/orgs/{org}/migrations/{migration_id}"},"summary":"Get an organization migration status","description":"Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n*   `pending`, which means the migration hasn't started yet.\n*   `exporting`, which means the migration is in progress.\n*   `exported`, which means the migration finished successfully.\n*   `failed`, which means the migration failed.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/migrations/{migration_id}/archive":{"get":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive","api_endpoint":"https://api.github.com/orgs/{org}/migrations/{migration_id}/archive"},"summary":"Download an organization migration archive","description":"Fetches the URL to a migration archive.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive","api_endpoint":"https://api.github.com/orgs/{org}/migrations/{migration_id}/archive"},"summary":"Delete an organization migration archive","description":"Deletes a previous migration archive. Migration archives are automatically deleted after seven days.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock":{"delete":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo_name","in":"path","description":"repo_name parameter","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository","api_endpoint":"https://api.github.com/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock"},"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/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/migrations/{migration_id}/repositories":{"get":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration","api_endpoint":"https://api.github.com/orgs/{org}/migrations/{migration_id}/repositories"},"summary":"List repositories in an organization migration","description":"List all the repositories for this organization migration.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/organization-roles":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/organization-roles/teams/{team_slug}":{"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/teams/{team_slug}"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}":{"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"role_id","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"number","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"role_id","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"number","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/organization-roles/users/{username}":{"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/users/{username}"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/organization-roles/users/{username}/{role_id}":{"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"role_id","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/users/{username}/{role_id}"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"role_id","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/users/{username}/{role_id}"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/organization-roles/{role_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"role_id","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/{role_id}"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/organization-roles/{role_id}/teams":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"role_id","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/{role_id}/teams"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/organization-roles/{role_id}/users":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"role_id","in":"path","description":"The unique identifier of the role.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role","api_endpoint":"https://api.github.com/orgs/{org}/organization-roles/{role_id}/users"},"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/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/outside_collaborators":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"filter","in":"query","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/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.","schema":{"type":"string","example":"","items":{"type":"string","enum":["2fa_disabled","2fa_insecure","all"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/outside_collaborators"},"summary":"List outside collaborators for an organization","description":"List all users who are outside collaborators of an organization.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/outside_collaborators/{username}":{"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator","api_endpoint":"https://api.github.com/orgs/{org}/outside_collaborators/{username}"},"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/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/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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.","enum":[true,false]}}},"example":{"async":""}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/outside_collaborators/{username}"},"summary":"Remove outside collaborator from an organization","description":"Removing a user from this list will remove them from all the organization's repositories.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/packages":{"get":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"query","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"visibility","in":"query","description":"The selected visibility of the packages.  This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"","schema":{"type":"string","example":"","items":{"type":"string","enum":["public","private","internal"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#list-packages-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/packages"},"summary":"List packages for an organization","description":"Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]}},"/orgs/{org}/packages/{package_type}/{package_name}":{"get":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/packages/{package_type}/{package_name}"},"summary":"Get a package for an organization","description":"Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]},"delete":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/packages/{package_type}/{package_name}"},"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.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/packages/{package_type}/{package_name}/restore":{"post":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"token","in":"query","description":"package token","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/packages/{package_type}/{package_name}/restore"},"summary":"Restore a package for an organization","description":"Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n  - The package was deleted within the last 30 days.\n  - 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.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/packages/{package_type}/{package_name}/versions":{"get":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"state","in":"query","description":"The state of the package, either active or deleted.","schema":{"type":"string","example":"","items":{"type":"string","enum":["active","deleted"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/packages/{package_type}/{package_name}/versions"},"summary":"List package versions for a package owned by an organization","description":"Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]}},"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}":{"get":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"},"summary":"Get a package version for an organization","description":"Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]},"delete":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"},"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.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore":{"post":{"tags":["Packages"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"},"summary":"Restore package version for an organization","description":"Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n  - The package was deleted within the last 30 days.\n  - 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.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/personal-access-token-requests":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"last_used_after","in":"query","description":"Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"last_used_before","in":"query","description":"Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"owner","in":"query","description":"A list of owner usernames to use to filter the results.","schema":{"type":"array","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"permission","in":"query","description":"The permission to use to filter the results.","schema":{"type":"string","example":""}},{"name":"repository","in":"query","description":"The name of the repository to use to filter the results.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property by which to sort the results.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created_at"]}}},{"name":"token_id","in":"query","description":"The ID of the token","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens","api_endpoint":"https://api.github.com/orgs/{org}/personal-access-token-requests"},"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.\n\nOnly GitHub Apps can use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens","api_endpoint":"https://api.github.com/orgs/{org}/personal-access-token-requests"},"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.\n\nOnly GitHub Apps can use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"Action to apply to the requests.","required":true,"enum":["approve","deny"]},"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":"number"}},"reason":{"type":"string","description":"Reason for approving or denying the requests. Max 1024 characters."}}},"example":{"action":"","pat_request_ids":[],"reason":""}}}}}},"/orgs/{org}/personal-access-token-requests/{pat_request_id}":{"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pat_request_id","in":"path","description":"Unique identifier of the request for access via fine-grained personal access token.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token","api_endpoint":"https://api.github.com/orgs/{org}/personal-access-token-requests/{pat_request_id}"},"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.\n\nOnly GitHub Apps can use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"Action to apply to the request.","required":true,"enum":["approve","deny"]},"reason":{"type":"string","description":"Reason for approving or denying the request. Max 1024 characters."}}},"example":{"action":"","reason":""}}}}}},"/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pat_request_id","in":"path","description":"Unique identifier of the request for access via fine-grained personal access token.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token","api_endpoint":"https://api.github.com/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories"},"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.\n\nOnly GitHub Apps can use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/personal-access-tokens":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"last_used_after","in":"query","description":"Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"last_used_before","in":"query","description":"Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"owner","in":"query","description":"A list of owner usernames to use to filter the results.","schema":{"type":"array","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"permission","in":"query","description":"The permission to use to filter the results.","schema":{"type":"string","example":""}},{"name":"repository","in":"query","description":"The name of the repository to use to filter the results.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property by which to sort the results.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created_at"]}}},{"name":"token_id","in":"query","description":"The ID of the token","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources","api_endpoint":"https://api.github.com/orgs/{org}/personal-access-tokens"},"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.\n\nOnly GitHub Apps can use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens","api_endpoint":"https://api.github.com/orgs/{org}/personal-access-tokens"},"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.\n\nOnly GitHub Apps can use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"Action to apply to the fine-grained personal access token.","required":true,"enum":["revoke"]},"pat_ids":{"type":"array","description":"The IDs of the fine-grained personal access tokens.","required":true,"items":{"type":"number"}}}},"example":{"action":"","pat_ids":[]}}}}}},"/orgs/{org}/personal-access-tokens/{pat_id}":{"post":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pat_id","in":"path","description":"The unique identifier of the fine-grained personal access token.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources","api_endpoint":"https://api.github.com/orgs/{org}/personal-access-tokens/{pat_id}"},"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.\n\nOnly GitHub Apps can use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"Action to apply to the fine-grained personal access token.","required":true,"enum":["revoke"]}}},"example":{"action":""}}}}}},"/orgs/{org}/personal-access-tokens/{pat_id}/repositories":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pat_id","in":"path","description":"Unique identifier of the fine-grained personal access token.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to","api_endpoint":"https://api.github.com/orgs/{org}/personal-access-tokens/{pat_id}/repositories"},"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.\n\nOnly GitHub Apps can use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/private-registries":{"get":{"tags":["Private Registries"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/private-registries"},"summary":"List private registries for an organization","description":"\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Private Registries"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/private-registries"},"summary":"Create a private registry for an organization","description":"\nCreates 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/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"account_id":{"type":"string","description":"The AWS account ID. Required when `auth_type` is `oidc_aws`."},"api_host":{"type":"string","description":"The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default."},"audience":{"type":"string","description":"The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types."},"auth_type":{"type":"string","description":"The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp` for OIDC authentication.","enum":["token","username_password","oidc_azure","oidc_aws","oidc_jfrog","oidc_cloudsmith","oidc_gcp"]},"aws_region":{"type":"string","description":"The AWS region. Required when `auth_type` is `oidc_aws`."},"client_id":{"type":"string","description":"The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`."},"domain":{"type":"string","description":"The CodeArtifact domain. Required when `auth_type` is `oidc_aws`."},"domain_owner":{"type":"string","description":"The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`."},"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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types."},"identity_mapping_name":{"type":"string","description":"The JFrog identity mapping name. Optional for `oidc_jfrog` auth type."},"jfrog_oidc_provider_name":{"type":"string","description":"The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`."},"key_id":{"type":"string","description":"The ID of the key you used to encrypt the secret. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types."},"namespace":{"type":"string","description":"The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`."},"registry_type":{"type":"string","description":"The registry type.","required":true,"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"]},"replaces_base":{"type":"boolean","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.","enum":[true,false]},"role_name":{"type":"string","description":"The AWS IAM role name. Required when `auth_type` is `oidc_aws`."},"selected_repository_ids":{"type":"array","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/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`.","items":{"type":"number"}},"service_account":{"type":"string","description":"The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF)."},"service_slug":{"type":"string","description":"The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`."},"tenant_id":{"type":"string","description":"The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`."},"url":{"type":"string","description":"The URL of the private registry.","required":true},"username":{"type":"string","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."},"visibility":{"type":"string","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.","required":true,"enum":["all","private","selected"]},"workload_identity_provider":{"type":"string","description":"The full resource name of the GCP Workload Identity Provider (e.g. `projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>`). Required when `auth_type` is `oidc_gcp`."}}},"example":{"account_id":"","api_host":"","audience":"","auth_type":"","aws_region":"","client_id":"","domain":"","domain_owner":"","encrypted_value":"","identity_mapping_name":"","jfrog_oidc_provider_name":"","key_id":"","namespace":"","registry_type":"","replaces_base":"","role_name":"","selected_repository_ids":[],"service_account":"","service_slug":"","tenant_id":"","url":"","username":"","visibility":"","workload_identity_provider":""}}}}}},"/orgs/{org}/private-registries/public-key":{"get":{"tags":["Private Registries"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/private-registries/public-key"},"summary":"Get private registries public key for an organization","description":"\nGets 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.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/private-registries/{secret_name}":{"get":{"tags":["Private Registries"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/private-registries/{secret_name}"},"summary":"Get a private registry for an organization","description":"\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Private Registries"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/private-registries/{secret_name}"},"summary":"Update a private registry for an organization","description":"\nUpdates 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/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, `oidc_jfrog`, `oidc_cloudsmith`, or `oidc_gcp`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"account_id":{"type":"string","description":"The AWS account ID. Required when `auth_type` is `oidc_aws`."},"api_host":{"type":"string","description":"The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default."},"audience":{"type":"string","description":"The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types."},"auth_type":{"type":"string","description":"The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.","enum":["token","username_password","oidc_azure","oidc_aws","oidc_jfrog","oidc_cloudsmith","oidc_gcp"]},"aws_region":{"type":"string","description":"The AWS region. Required when `auth_type` is `oidc_aws`."},"client_id":{"type":"string","description":"The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`."},"domain":{"type":"string","description":"The CodeArtifact domain. Required when `auth_type` is `oidc_aws`."},"domain_owner":{"type":"string","description":"The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`."},"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 private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint."},"identity_mapping_name":{"type":"string","description":"The JFrog identity mapping name. Optional for `oidc_jfrog` auth type."},"jfrog_oidc_provider_name":{"type":"string","description":"The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`."},"key_id":{"type":"string","description":"The ID of the key you used to encrypt the secret."},"namespace":{"type":"string","description":"The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`."},"registry_type":{"type":"string","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"]},"replaces_base":{"type":"boolean","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.","enum":[true,false]},"role_name":{"type":"string","description":"The AWS IAM role name. Required when `auth_type` is `oidc_aws`."},"selected_repository_ids":{"type":"array","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`.","items":{"type":"number"}},"service_account":{"type":"string","description":"The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF)."},"service_slug":{"type":"string","description":"The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`."},"tenant_id":{"type":"string","description":"The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`."},"url":{"type":"string","description":"The URL of the private registry."},"username":{"type":"string","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."},"visibility":{"type":"string","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"]},"workload_identity_provider":{"type":"string","description":"The full resource name of the GCP Workload Identity Provider (e.g. `projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>`). Required when `auth_type` is `oidc_gcp`."}}},"example":{"account_id":"","api_host":"","audience":"","auth_type":"","aws_region":"","client_id":"","domain":"","domain_owner":"","encrypted_value":"","identity_mapping_name":"","jfrog_oidc_provider_name":"","key_id":"","namespace":"","registry_type":"","replaces_base":"","role_name":"","selected_repository_ids":[],"service_account":"","service_slug":"","tenant_id":"","url":"","username":"","visibility":"","workload_identity_provider":""}}}}},"delete":{"tags":["Private Registries"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/private-registries/{secret_name}"},"summary":"Delete a private registry for an organization","description":"\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/projectsV2":{"get":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"Limit results to projects of the specified type.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/projects#list-projects-for-organization","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2"},"summary":"List projects for organization","description":"List all projects owned by a specific organization accessible by the authenticated user.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/projectsV2/{project_number}":{"get":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/projects#get-project-for-organization","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}"},"summary":"Get project for organization","description":"Get a specific organization-owned project.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/projectsV2/{project_number}/drafts":{"post":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/drafts"},"summary":"Create draft item for organization owned project","description":"Create draft issue item for the specified organization owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The body content of the draft issue item to create in the project."},"title":{"type":"string","description":"The title of the draft issue item to create in the project.","required":true}}},"example":{"body":"","title":""}}}}}},"/orgs/{org}/projectsV2/{project_number}/fields":{"get":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/fields#list-project-fields-for-organization","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/fields"},"summary":"List project fields for organization","description":"List all fields for a specific organization-owned project.","security":[{"bearerAuth":[]}]},"post":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/fields"},"summary":"Add a field to an organization-owned project.","description":"Add a field to an organization-owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"issue_field_id":{"type":"number","description":"The ID of the IssueField to create the field for.","required":true}}},"example":{"issue_field_id":""}}}}}},"/orgs/{org}/projectsV2/{project_number}/fields/{field_id}":{"get":{"tags":["Projects"],"parameters":[{"name":"field_id","in":"path","description":"The unique identifier of the field.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/fields#get-project-field-for-organization","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/fields/{field_id}"},"summary":"Get project field for organization","description":"Get a specific field for an organization-owned project.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/projectsV2/{project_number}/items":{"get":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/items"},"summary":"List items for an organization owned project","description":"List all items for a specific organization-owned project accessible by the authenticated user.","security":[{"bearerAuth":[]}]},"post":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/items"},"summary":"Add item to organization owned project","description":"Add an issue or pull request item to the specified organization owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"The type of item to add to the project. Must be either Issue or PullRequest.","required":true,"enum":["Issue","PullRequest"]},"id":{"type":"number","description":"The unique identifier of the issue or pull request to add to the project."},"number":{"type":"number","description":"The issue or pull request number."},"owner":{"type":"string","description":"The repository owner login."},"repo":{"type":"string","description":"The repository name."}}},"example":{"type":"","id":"","number":"","owner":"","repo":""}}}}}},"/orgs/{org}/projectsV2/{project_number}/items/{item_id}":{"get":{"tags":["Projects"],"parameters":[{"name":"item_id","in":"path","description":"The unique identifier of the project item.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"fields","in":"query","description":"Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/items/{item_id}"},"summary":"Get an item for an organization owned project","description":"Get a specific item from an organization-owned project.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Projects"],"parameters":[{"name":"item_id","in":"path","description":"The unique identifier of the project item.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#update-project-item-for-organization","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/items/{item_id}"},"summary":"Update project item for organization","description":"Update a specific item in an organization-owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A list of field updates to apply.","required":true,"items":{"type":"object","properties":{"id":{"type":"number","description":"The ID of the project field to update.","required":true},"value":{"type":"string","description":"The new value for the field:\n- For text, number, and date fields, provide the new value directly.\n- For single select and iteration fields, provide the ID of the option or iteration.\n- To clear the field, set this to null.","required":true}}}}}},"example":{"fields":[]}}}}},"delete":{"tags":["Projects"],"parameters":[{"name":"item_id","in":"path","description":"The unique identifier of the project item.","required":true,"schema":{"type":"number","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#delete-project-item-for-organization","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/items/{item_id}"},"summary":"Delete project item for organization","description":"Delete a specific item from an organization-owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/projectsV2/{project_number}/views":{"post":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/views"},"summary":"Create a view for an organization-owned project","description":"Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"filter":{"type":"string","description":"The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information."},"group_by":{"type":"array","description":"The field IDs to group items by (horizontal grouping). Supports a single field. The field must support grouping; fields such as `Title`, `Reviewers`, `Linked pull requests`, `Sub-issues progress`, `Tracked by`, and `Tracks` cannot be grouped on.","items":{"type":"number"}},"layout":{"type":"string","description":"The layout of the view.","required":true,"enum":["table","board","roadmap"]},"name":{"type":"string","description":"The name of the view.","required":true},"sort_by":{"type":"array","description":"Sorting configuration for the view. Each element is a two-element array of `[field_id, direction]` where `direction` is `\"asc\"` or `\"desc\"`. Supports multiple sort criteria applied in order.","items":{"type":"array"}},"vertical_group_by":{"type":"array","description":"The field IDs to use as columns in `board` layout (vertical grouping). Supports a single field. The field must support grouping; fields such as `Title`, `Reviewers`, `Linked pull requests`, `Sub-issues progress`, `Tracked by`, and `Tracks` cannot be grouped on.","items":{"type":"number"}},"visible_fields":{"type":"array","description":"`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.","items":{"type":"number"}}}},"example":{"filter":"","group_by":[],"layout":"","name":"","sort_by":[],"vertical_group_by":[],"visible_fields":[]}}}}}},"/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items":{"get":{"tags":["Projects"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"view_number","in":"path","description":"The number that identifies the project view.","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Limit results to specific fields, by their IDs. If not specified, the\ntitle field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view","api_endpoint":"https://api.github.com/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items"},"summary":"List items for an organization project view","description":"List items in an organization project with the saved view's filter applied.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/properties/schema":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/properties/schema"},"summary":"Get all custom properties for an organization","description":"Gets all custom properties defined for an organization.\nOrganization members can read these properties.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/properties/schema"},"summary":"Create or update custom properties for an organization","description":"Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.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`.\n\nTo use this endpoint, the authenticated user must be one of:\n  - An administrator for the organization.\n  - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"array","description":"The array of custom properties to create or update.","required":true,"items":{"type":"object","properties":{"allowed_values":{"type":"array","description":"An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values."},"default_value":{"type":"string","description":"Default value of the property"},"description":{"type":"string","description":"Short description of the property"},"property_name":{"type":"string","description":"The name of the property","required":true},"require_explicit_values":{"type":"boolean","description":"Whether setting properties values is mandatory","enum":[true,false]},"required":{"type":"boolean","description":"Whether the property is required.","enum":[true,false]},"source_type":{"type":"string","description":"The source type of the property","enum":["organization","enterprise"]},"url":{"type":"string","description":"The URL that can be used to fetch, update, or delete info about this property via the API."},"value_type":{"type":"string","description":"The type of the value for the property","required":true,"enum":["string","single_select","multi_select","true_false","url"]},"values_editable_by":{"type":"string","description":"Who can edit the values of the property","enum":["org_actors","org_and_repo_actors"]}}}}}},"example":{"properties":[]}}}}}},"/orgs/{org}/properties/schema/{custom_property_name}":{"get":{"tags":["Organizations"],"parameters":[{"name":"custom_property_name","in":"path","description":"The custom property name","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/properties/schema/{custom_property_name}"},"summary":"Get a custom property for an organization","description":"Gets a custom property that is defined for an organization.\nOrganization members can read these properties.","security":[{"bearerAuth":[]}]},"put":{"tags":["Organizations"],"parameters":[{"name":"custom_property_name","in":"path","description":"The custom property name","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/properties/schema/{custom_property_name}"},"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.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_values":{"type":"array","description":"An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.","items":{"type":"string"}},"default_value":{"type":"string","description":"Default value of the property"},"description":{"type":"string","description":"Short description of the property"},"require_explicit_values":{"type":"boolean","description":"Whether setting properties values is mandatory","enum":[true,false]},"required":{"type":"boolean","description":"Whether the property is required.","enum":[true,false]},"value_type":{"type":"string","description":"The type of the value for the property","required":true,"enum":["string","single_select","multi_select","true_false","url"]},"values_editable_by":{"type":"string","description":"Who can edit the values of the property","enum":["org_actors","org_and_repo_actors"]}}},"example":{"allowed_values":[],"default_value":"","description":"","require_explicit_values":"","required":"","value_type":"","values_editable_by":""}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"custom_property_name","in":"path","description":"The custom property name","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/properties/schema/{custom_property_name}"},"summary":"Remove a custom property for an organization","description":"Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n  - An administrator for the organization.\n  - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/properties/values":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"repository_query","in":"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. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories","api_endpoint":"https://api.github.com/orgs/{org}/properties/values"},"summary":"List custom property values for organization repositories","description":"Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories","api_endpoint":"https://api.github.com/orgs/{org}/properties/values"},"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.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n  - An administrator for the organization.\n  - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"array","description":"List of custom property names and associated values to apply to the repositories.","required":true,"items":{"type":"object","properties":{"property_name":{"type":"string","description":"The name of the property","required":true},"value":{"type":"string","description":"The value assigned to the property","required":true}}}},"repository_names":{"type":"array","description":"The names of repositories that the custom property values will be applied to.","required":true,"items":{"type":"string"}}}},"example":{"properties":[],"repository_names":[]}}}}}},"/orgs/{org}/public_members":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#list-public-organization-members","api_endpoint":"https://api.github.com/orgs/{org}/public_members"},"summary":"List public organization members","description":"Members of an organization can choose to have their membership publicized or not.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/public_members/{username}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/public_members/{username}"},"summary":"Check public organization membership for a user","description":"Check if the provided user is a public member of the organization.","security":[{"bearerAuth":[]}]},"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user","api_endpoint":"https://api.github.com/orgs/{org}/public_members/{username}"},"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.)\n\nNote 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/rest/guides/getting-started-with-the-rest-api#http-method).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user","api_endpoint":"https://api.github.com/orgs/{org}/public_members/{username}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/repos":{"get":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"Specifies the types of repositories you want returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","public","private","forks","sources","member"]}}},{"name":"direction","in":"query","description":"The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","pushed","full_name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-organization-repositories","api_endpoint":"https://api.github.com/orgs/{org}/repos"},"summary":"List organization repositories","description":"Lists repositories for the specified organization.\n\n> [!NOTE]\n> 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#create-an-organization-repository","api_endpoint":"https://api.github.com/orgs/{org}/repos"},"summary":"Create an organization repository","description":"Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_auto_merge":{"type":"boolean","description":"Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.","enum":[true,false]},"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.","enum":[true,false]},"allow_rebase_merge":{"type":"boolean","description":"Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.","enum":[true,false]},"allow_squash_merge":{"type":"boolean","description":"Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.","enum":[true,false]},"auto_init":{"type":"boolean","description":"Pass `true` to create an initial commit with empty README.","enum":[true,false]},"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.","properties":{}},"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`.**","enum":[true,false]},"description":{"type":"string","description":"A short description of the repository."},"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\"."},"has_downloads":{"type":"boolean","description":"Whether downloads are enabled.","enum":[true,false]},"has_issues":{"type":"boolean","description":"Either `true` to enable issues for this repository or `false` to disable them.","enum":[true,false]},"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.","enum":[true,false]},"has_wiki":{"type":"boolean","description":"Either `true` to enable the wiki for this repository or `false` to disable it.","enum":[true,false]},"homepage":{"type":"string","description":"A URL with more information about the repository."},"is_template":{"type":"boolean","description":"Either `true` to make this repo available as a template repository or `false` to prevent it.","enum":[true,false]},"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/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"."},"merge_commit_message":{"type":"string","description":"The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.","enum":["PR_BODY","PR_TITLE","BLANK"]},"merge_commit_title":{"type":"string","description":"Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).","enum":["PR_TITLE","MERGE_MESSAGE"]},"name":{"type":"string","description":"The name of the repository.","required":true},"private":{"type":"boolean","description":"Whether the repository is private.","enum":[true,false]},"squash_merge_commit_message":{"type":"string","description":"The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.","enum":["PR_BODY","COMMIT_MESSAGES","BLANK"]},"squash_merge_commit_title":{"type":"string","description":"Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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).","enum":["PR_TITLE","COMMIT_OR_PR_TITLE"]},"team_id":{"type":"number","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."},"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.","enum":[true,false]},"visibility":{"type":"string","description":"The visibility of the repository.","enum":["public","private"]}}},"example":{"allow_auto_merge":"","allow_merge_commit":"","allow_rebase_merge":"","allow_squash_merge":"","auto_init":"","custom_properties":{},"delete_branch_on_merge":"","description":"","gitignore_template":"","has_downloads":"","has_issues":"","has_projects":"","has_wiki":"","homepage":"","is_template":"","license_template":"","merge_commit_message":"","merge_commit_title":"","name":"","private":"","squash_merge_commit_message":"","squash_merge_commit_title":"","team_id":"","use_squash_pr_title_as_default":"","visibility":""}}}}}},"/orgs/{org}/rulesets":{"get":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"targets","in":"query","description":"A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets","api_endpoint":"https://api.github.com/orgs/{org}/rulesets"},"summary":"Get all organization repository rulesets","description":"Get all the repository rulesets for an organization.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset","api_endpoint":"https://api.github.com/orgs/{org}/rulesets"},"summary":"Create an organization repository ruleset","description":"Create a repository ruleset for an organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bypass_actors":{"type":"array","description":"The actors that can bypass the rules in this ruleset","items":{"type":"object","properties":{"actor_id":{"type":"number","description":"The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories."},"actor_type":{"type":"string","description":"The type of actor that can bypass a ruleset.","required":true,"enum":["Integration","OrganizationAdmin","RepositoryRole","Team","DeployKey","User"]},"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"]}}}},"conditions":{"type":"object","description":"Conditions for an organization ruleset.\nThe 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.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.","properties":{}},"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 only available with GitHub Enterprise).","required":true,"enum":["disabled","active","evaluate"]},"name":{"type":"string","description":"The name of the ruleset.","required":true},"rules":{"type":"array","description":"An array of rules within the ruleset.","items":{"type":"object","properties":{}}},"target":{"type":"string","description":"The target of the ruleset","enum":["branch","tag","push","repository"]}}},"example":{"bypass_actors":[],"conditions":{},"enforcement":"","name":"","rules":[],"target":""}}}}}},"/orgs/{org}/rulesets/rule-suites":{"get":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"actor_name","in":"query","description":"The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.","schema":{"type":"string","example":""}},{"name":"evaluate_status","in":"query","description":"The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned.\n  - `all` - all rule suites will be returned.\n  - `active` - only rule suites resulting from rulesets in active (non-evaluate) mode will be returned.\n  - `evaluate` - only rule suites resulting from rulesets in evaluate mode will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","active","evaluate"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"ref","in":"query","description":"The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.","schema":{"type":"string","example":""}},{"name":"repository_name","in":"query","description":"The name of the repository to filter on.","schema":{"type":"string","example":""}},{"name":"rule_suite_result","in":"query","description":"The rule suite results to filter on. When specified, only suites with this result will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["pass","fail","bypass","all"]}}},{"name":"time_period","in":"query","description":"The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).","schema":{"type":"string","example":"","items":{"type":"string","enum":["hour","day","week","month"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites","api_endpoint":"https://api.github.com/orgs/{org}/rulesets/rule-suites"},"summary":"List organization rule suites","description":"Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"","security":[{"bearerAuth":[]}]}},"/orgs/{org}/rulesets/rule-suites/{rule_suite_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"rule_suite_id","in":"path","description":"The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite","api_endpoint":"https://api.github.com/orgs/{org}/rulesets/rule-suites/{rule_suite_id}"},"summary":"Get an organization rule suite","description":"Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"","security":[{"bearerAuth":[]}]}},"/orgs/{org}/rulesets/{ruleset_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset","api_endpoint":"https://api.github.com/orgs/{org}/rulesets/{ruleset_id}"},"summary":"Get an organization repository ruleset","description":"Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset","api_endpoint":"https://api.github.com/orgs/{org}/rulesets/{ruleset_id}"},"summary":"Update an organization repository ruleset","description":"Update a ruleset for an organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bypass_actors":{"type":"array","description":"The actors that can bypass the rules in this ruleset","items":{"type":"object","properties":{"actor_id":{"type":"number","description":"The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories."},"actor_type":{"type":"string","description":"The type of actor that can bypass a ruleset.","required":true,"enum":["Integration","OrganizationAdmin","RepositoryRole","Team","DeployKey","User"]},"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"]}}}},"conditions":{"type":"object","description":"Conditions for an organization ruleset.\nThe 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.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.","properties":{}},"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 only available with GitHub Enterprise).","enum":["disabled","active","evaluate"]},"name":{"type":"string","description":"The name of the ruleset."},"rules":{"type":"array","description":"An array of rules within the ruleset.","items":{"type":"object","properties":{}}},"target":{"type":"string","description":"The target of the ruleset","enum":["branch","tag","push","repository"]}}},"example":{"bypass_actors":[],"conditions":{},"enforcement":"","name":"","rules":[],"target":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset","api_endpoint":"https://api.github.com/orgs/{org}/rulesets/{ruleset_id}"},"summary":"Delete an organization repository ruleset","description":"Delete a ruleset for an organization.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/rulesets/{ruleset_id}/history":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history","api_endpoint":"https://api.github.com/orgs/{org}/rulesets/{ruleset_id}/history"},"summary":"Get organization ruleset history","description":"Get the history of an organization ruleset.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}},{"name":"version_id","in":"path","description":"The ID of the version","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version","api_endpoint":"https://api.github.com/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}"},"summary":"Get organization ruleset version","description":"Get a version of an organization ruleset.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/secret-scanning/alerts":{"get":{"tags":["Secret Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.  To receive an initial cursor on your first request, include an empty \"after\" query string.","schema":{"type":"string","example":""}},{"name":"assignee","in":"query","description":"Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"exclude_providers","in":"query","description":"A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.","schema":{"type":"string","example":""}},{"name":"exclude_secret_types","in":"query","description":"A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.","schema":{"type":"string","example":""}},{"name":"hide_secret","in":"query","description":"A boolean value representing whether or not to hide literal secrets in the results.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"included_metadata","in":"query","description":"A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.","schema":{"type":"string","example":""}},{"name":"is_bypassed","in":"query","description":"A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"is_multi_repo","in":"query","description":"A boolean value representing whether or not to filter alerts by the multi-repo tag being present.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"is_publicly_leaked","in":"query","description":"A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"owner_email_hash","in":"query","description":"Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"providers","in":"query","description":"A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.","schema":{"type":"string","example":""}},{"name":"resolution","in":"query","description":"A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.","schema":{"type":"string","example":""}},{"name":"secret_type","in":"query","description":"A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}},{"name":"state","in":"query","description":"Set to `open` or `resolved` to only list secret scanning alerts in a specific state.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","resolved"]}}},{"name":"validity","in":"query","description":"A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/secret-scanning/alerts"},"summary":"List secret scanning alerts for an organization","description":"Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/secret-scanning/custom-patterns":{"get":{"tags":["Secret Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"push_protection","in":"query","description":"Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.","schema":{"type":"string","example":"","items":{"type":"string","enum":["enabled","disabled"]}}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","name"]}}},{"name":"state","in":"query","description":"Filter custom patterns by state. When absent, returns patterns in all states.","schema":{"type":"string","example":"","items":{"type":"string","enum":["published","unpublished"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns","api_endpoint":"https://api.github.com/orgs/{org}/secret-scanning/custom-patterns"},"summary":"List organization custom patterns","description":"Lists secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Secret Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns","api_endpoint":"https://api.github.com/orgs/{org}/secret-scanning/custom-patterns"},"summary":"Bulk create organization custom patterns","description":"Bulk creates secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"patterns":{"type":"array","description":"The list of custom patterns to create.","required":true,"items":{"type":"object","properties":{"end_delimiter":{"type":"string","description":"The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified."},"must_match":{"type":"array","description":"List of regexes that the secret must match."},"must_not_match":{"type":"array","description":"List of regexes that the secret must not match."},"name":{"type":"string","description":"The name of the custom pattern.","required":true},"pattern":{"type":"string","description":"The regular expression of the custom pattern.","required":true},"start_delimiter":{"type":"string","description":"The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified."}}}}}},"example":{"patterns":[]}}}}},"delete":{"tags":["Secret Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns","api_endpoint":"https://api.github.com/orgs/{org}/secret-scanning/custom-patterns"},"summary":"Bulk delete organization custom patterns","description":"Bulk deletes secret scanning custom patterns for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"patterns":{"type":"array","description":"The list of custom patterns to delete.","required":true,"items":{"type":"object","properties":{"custom_pattern_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."},"pattern_id":{"type":"number","description":"The ID of the custom pattern to delete.","required":true}}}},"post_delete_action":{"type":"string","description":"What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.","enum":["delete_alerts","resolve_alerts"]}}},"example":{"patterns":[],"post_delete_action":""}}}}}},"/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}":{"patch":{"tags":["Secret Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"The ID of the custom pattern.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern","api_endpoint":"https://api.github.com/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}"},"summary":"Update an organization custom pattern","description":"Updates a secret scanning custom pattern for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_pattern_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.","required":true},"end_delimiter":{"type":"string","description":"The updated end delimiter regex for the custom pattern."},"must_match":{"type":"array","description":"Updated list of regexes that the secret must match.","items":{"type":"string"}},"must_not_match":{"type":"array","description":"Updated list of regexes that the secret must not match.","items":{"type":"string"}},"pattern":{"type":"string","description":"The updated regular expression of the custom pattern."},"start_delimiter":{"type":"string","description":"The updated start delimiter regex for the custom pattern."}}},"example":{"custom_pattern_version":"","end_delimiter":"","must_match":[],"must_not_match":[],"pattern":"","start_delimiter":""}}}}}},"/orgs/{org}/secret-scanning/pattern-configurations":{"get":{"tags":["Secret Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations","api_endpoint":"https://api.github.com/orgs/{org}/secret-scanning/pattern-configurations"},"summary":"List organization pattern configurations","description":"Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Secret Scanning"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations","api_endpoint":"https://api.github.com/orgs/{org}/secret-scanning/pattern-configurations"},"summary":"Update organization pattern configurations","description":"Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_pattern_settings":{"type":"array","description":"Pattern settings for custom patterns.","items":{"type":"object","properties":{"custom_pattern_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."},"push_protection_setting":{"type":"string","description":"Push protection setting to set for the pattern.","enum":["disabled","enabled"]},"token_type":{"type":"string","description":"The ID of the pattern to configure."}}}},"pattern_config_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."},"provider_pattern_settings":{"type":"array","description":"Pattern settings for provider patterns.","items":{"type":"object","properties":{"push_protection_setting":{"type":"string","description":"Push protection setting to set for the pattern.","enum":["not-set","disabled","enabled"]},"token_type":{"type":"string","description":"The ID of the pattern to configure."}}}}}},"example":{"custom_pattern_settings":[],"pattern_config_version":"","provider_pattern_settings":[]}}}}}},"/orgs/{org}/security-advisories":{"get":{"tags":["Security Advisories"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"per_page","in":"query","description":"The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","published"]}}},{"name":"state","in":"query","description":"Filter by the state of the repository advisories. Only advisories of this state will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["triage","draft","published","closed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/security-advisories"},"summary":"List repository security advisories for an organization","description":"Lists repository security advisories for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/security-managers":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams","api_endpoint":"https://api.github.com/orgs/{org}/security-managers"},"summary":"List security manager teams","description":"> [!WARNING]\n> **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/rest/orgs/organization-roles)\" endpoints instead.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/security-managers/teams/{team_slug}":{"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team","api_endpoint":"https://api.github.com/orgs/{org}/security-managers/teams/{team_slug}"},"summary":"Add a security manager team","description":"> [!WARNING]\n> **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/rest/orgs/organization-roles)\" endpoints instead.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team","api_endpoint":"https://api.github.com/orgs/{org}/security-managers/teams/{team_slug}"},"summary":"Remove a security manager team","description":"> [!WARNING]\n> **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/rest/orgs/organization-roles)\" endpoints instead.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/settings/immutable-releases":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/immutable-releases"},"summary":"Get immutable releases settings for an organization","description":"Gets the immutable releases policy for repositories in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/immutable-releases"},"summary":"Set immutable releases settings for an organization","description":"Sets the immutable releases policy for repositories in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enforced_repositories":{"type":"string","description":"The policy that controls how immutable releases are enforced in the organization.","required":true,"enum":["all","none","selected"]},"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/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/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.","items":{"type":"number"}}}},"example":{"enforced_repositories":"","selected_repository_ids":[]}}}}}},"/orgs/{org}/settings/immutable-releases/repositories":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement","api_endpoint":"https://api.github.com/orgs/{org}/settings/immutable-releases/repositories"},"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.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement","api_endpoint":"https://api.github.com/orgs/{org}/settings/immutable-releases/repositories"},"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`.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/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/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/orgs/{org}/settings/immutable-releases/repositories/{repository_id}":{"put":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/immutable-releases/repositories/{repository_id}"},"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`.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/immutable-releases/repositories/{repository_id}"},"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`.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/settings/network-configurations":{"get":{"tags":["Hosted Compute"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/network-configurations"},"summary":"List hosted compute network configurations for an organization","description":"Lists all hosted compute network configurations configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Hosted Compute"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/network-configurations"},"summary":"Create a hosted compute network configuration for an organization","description":"Creates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"compute_service":{"type":"string","description":"The hosted compute service to use for the network configuration.","enum":["none","actions"]},"failover_network_enabled":{"type":"boolean","description":"Indicates whether the failover network resource is enabled.","enum":[true,false]},"failover_network_settings_ids":{"type":"array","description":"A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.","items":{"type":"string"}},"name":{"type":"string","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 '_'.","required":true},"network_settings_ids":{"type":"array","description":"A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.","required":true,"items":{"type":"string"}}}},"example":{"compute_service":"","failover_network_enabled":"","failover_network_settings_ids":[],"name":"","network_settings_ids":[]}}}}}},"/orgs/{org}/settings/network-configurations/{network_configuration_id}":{"get":{"tags":["Hosted Compute"],"parameters":[{"name":"network_configuration_id","in":"path","description":"Unique identifier of the hosted compute network configuration.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/network-configurations/{network_configuration_id}"},"summary":"Get a hosted compute network configuration for an organization","description":"Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Hosted Compute"],"parameters":[{"name":"network_configuration_id","in":"path","description":"Unique identifier of the hosted compute network configuration.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/network-configurations/{network_configuration_id}"},"summary":"Update a hosted compute network configuration for an organization","description":"Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"compute_service":{"type":"string","description":"The hosted compute service to use for the network configuration.","enum":["none","actions"]},"failover_network_enabled":{"type":"boolean","description":"Indicates whether the failover network resource is enabled.","enum":[true,false]},"failover_network_settings_ids":{"type":"array","description":"A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.","items":{"type":"string"}},"name":{"type":"string","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 '_'."},"network_settings_ids":{"type":"array","description":"A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.","items":{"type":"string"}}}},"example":{"compute_service":"","failover_network_enabled":"","failover_network_settings_ids":[],"name":"","network_settings_ids":[]}}}}},"delete":{"tags":["Hosted Compute"],"parameters":[{"name":"network_configuration_id","in":"path","description":"Unique identifier of the hosted compute network configuration.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/network-configurations/{network_configuration_id}"},"summary":"Delete a hosted compute network configuration from an organization","description":"Deletes a hosted compute network configuration from an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/settings/network-settings/{network_settings_id}":{"get":{"tags":["Hosted Compute"],"parameters":[{"name":"network_settings_id","in":"path","description":"Unique identifier of the hosted compute network settings.","required":true,"schema":{"type":"string","example":""}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/settings/network-settings/{network_settings_id}"},"summary":"Get a hosted compute network settings resource for an organization","description":"Gets a hosted compute network settings resource configured for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/teams":{"get":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"team_type","in":"query","description":"Filter team results by their type. For more information, see \"[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)\"","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","enterprise","organization"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#list-teams","api_endpoint":"https://api.github.com/orgs/{org}/teams"},"summary":"List teams","description":"Lists all teams in an organization that are visible to the authenticated user.","security":[{"bearerAuth":[]}]},"post":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#create-a-team","api_endpoint":"https://api.github.com/orgs/{org}/teams"},"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/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen 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/github/setting-up-and-managing-organizations-and-teams/about-teams)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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"}},"name":{"type":"string","description":"The name of the team.","required":true},"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"]},"parent_team_id":{"type":"number","description":"The ID of a team to set as the parent team."},"parent_team_slug":{"type":"string","description":"The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided."},"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"]},"repo_names":{"type":"array","description":"The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.","items":{"type":"string"}}}},"example":{"description":"","maintainers":[],"name":"","notification_setting":"","parent_team_id":"","parent_team_slug":"","privacy":"","repo_names":[]}}}}}},"/orgs/{org}/teams/{team_slug}":{"get":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#get-a-team-by-name","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}"},"summary":"Get a team by name","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. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#update-a-team","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}"},"summary":"Update a team","description":"To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the team."},"name":{"type":"string","description":"The name of the team."},"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"]},"parent_team_id":{"type":"number","description":"The ID of a team to set as the parent team."},"parent_team_slug":{"type":"string","description":"The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided."},"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"]},"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"]}}},"example":{"description":"","name":"","notification_setting":"","parent_team_id":"","parent_team_slug":"","permission":"","privacy":""}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#delete-a-team","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}"},"summary":"Delete a team","description":"To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/teams/{team_slug}/invitations":{"get":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#list-pending-team-invitations","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/invitations"},"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 member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/teams/{team_slug}/members":{"get":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"role","in":"query","description":"Filters members returned by their role in the team.","schema":{"type":"string","example":"","items":{"type":"string","enum":["member","maintainer","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#list-team-members","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/members"},"summary":"List team members","description":"Team members will include the members of child teams.\n\nEach member includes their `role` on the team (`member` or `maintainer`) and an `inherited` flag indicating whether the membership is inherited from a child team (`true`) or is a direct membership (`false`). These fields let you read a member's role and direct/inherited status without additional requests.\n\nTo list members in a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/members`.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/teams/{team_slug}/memberships/{username}":{"get":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#get-team-membership-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/memberships/{username}"},"summary":"Get team membership for a user","description":"Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).","security":[{"bearerAuth":[]}]},"put":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/memberships/{username}"},"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.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> 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 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](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn 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.\n\nIf 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.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"role":{"type":"string","description":"The role that this user should have in the team.","enum":["member","maintainer"]}}},"example":{"role":""}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/memberships/{username}"},"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.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> 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 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](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/teams/{team_slug}/repos":{"get":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#list-team-repositories","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/repos"},"summary":"List team repositories","description":"Lists a team's repositories visible to the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` or `repo` scope to use this endpoint.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}":{"get":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"},"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.\n\nYou 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/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf 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.\n\n> [!NOTE]\n> 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}`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"},"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/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> 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}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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."}}},"example":{"permission":""}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"},"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.\n\n> [!NOTE]\n> 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}`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/orgs/{org}/teams/{team_slug}/teams":{"get":{"tags":["Teams"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_slug","in":"path","description":"The slug of the team name.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#list-child-teams","api_endpoint":"https://api.github.com/orgs/{org}/teams/{team_slug}/teams"},"summary":"List child teams","description":"Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.","security":[{"bearerAuth":[]}]}},"/orgs/{org}/{security_product}/{enablement}":{"post":{"tags":["Organizations"],"parameters":[{"name":"enablement","in":"path","description":"The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["enable_all","disable_all"]}}},{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"security_product","in":"path","description":"The security feature to enable or disable.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dependency_graph","dependabot_alerts","dependabot_security_updates","advanced_security","code_scanning_default_setup","secret_scanning","secret_scanning_push_protection"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization","api_endpoint":"https://api.github.com/orgs/{org}/{security_product}/{enablement}"},"summary":"Enable or disable a security feature for an organization","description":"> [!WARNING]\n> **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/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/).\n\nEnables 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query_suite":{"type":"string","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.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.","enum":["default","extended"]}}},"example":{"query_suite":""}}}}}},"/rate_limit":{"get":{"tags":["Rate Limit"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user","api_endpoint":"https://api.github.com/rate_limit"},"summary":"Get rate limit status for the authenticated user","description":"> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* 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/rest/search/search).\"\n* 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/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* 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/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).\"\n* 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/rest/dependency-graph).\"\n* 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/rest/dependency-graph).\"\n* 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/rest/actions/self-hosted-runners).\"\n* 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/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#get-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}"},"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.\n\n> [!NOTE]\n> - 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#update-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}"},"summary":"Update a repository","description":"**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_auto_merge":{"type":"boolean","description":"Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.","enum":[true,false]},"allow_forking":{"type":"boolean","description":"Either `true` to allow private forks, or `false` to prevent private forks.","enum":[true,false]},"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.","enum":[true,false]},"allow_rebase_merge":{"type":"boolean","description":"Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.","enum":[true,false]},"allow_squash_merge":{"type":"boolean","description":"Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.","enum":[true,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.","enum":[true,false]},"archived":{"type":"boolean","description":"Whether to archive this repository. `false` will unarchive a previously archived repository.","enum":[true,false]},"default_branch":{"type":"string","description":"Updates the default branch for this repository."},"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.","enum":[true,false]},"description":{"type":"string","description":"A short description of the repository."},"has_issues":{"type":"boolean","description":"Either `true` to enable issues for this repository or `false` to disable them.","enum":[true,false]},"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.","enum":[true,false]},"has_pull_requests":{"type":"boolean","description":"Either `true` to allow pull requests for this repository or `false` to prevent pull requests.","enum":[true,false]},"has_wiki":{"type":"boolean","description":"Either `true` to enable the wiki for this repository or `false` to disable it.","enum":[true,false]},"homepage":{"type":"string","description":"A URL with more information about the repository."},"is_template":{"type":"boolean","description":"Either `true` to make this repo available as a template repository or `false` to prevent it.","enum":[true,false]},"merge_commit_message":{"type":"string","description":"The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.","enum":["PR_BODY","PR_TITLE","BLANK"]},"merge_commit_title":{"type":"string","description":"Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).","enum":["PR_TITLE","MERGE_MESSAGE"]},"name":{"type":"string","description":"The name of 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/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.","enum":[true,false]},"pull_request_creation_policy":{"type":"string","description":"The policy that controls who can create pull requests for this repository: `all` or `collaborators_only`.","enum":["all","collaborators_only"]},"security_and_analysis":{"type":"object","description":"Specify which security and analysis features to enable or disable for the repository.\n\nTo 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.","properties":{"advanced_security":{"type":"object","description":"Use the `status` property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"[About GitHub Advanced\nSecurity](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used."},"code_security":{"type":"object","description":"Use the `status` property to enable or disable GitHub Code Security for this repository."},"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).\""},"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/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\""},"secret_scanning_delegated_alert_dismissal":{"type":"object","description":"Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository."},"secret_scanning_delegated_bypass":{"type":"object","description":"Use the `status` property to enable or disable secret scanning delegated bypass for this repository."},"secret_scanning_delegated_bypass_options":{"type":"object","description":"Feature options for secret scanning delegated bypass.\nThis object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`.\nYou can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request."},"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).\""},"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).\""}}},"squash_merge_commit_message":{"type":"string","description":"The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.","enum":["PR_BODY","COMMIT_MESSAGES","BLANK"]},"squash_merge_commit_title":{"type":"string","description":"Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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).","enum":["PR_TITLE","COMMIT_OR_PR_TITLE"]},"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.","enum":[true,false]},"visibility":{"type":"string","description":"The visibility of the repository.","enum":["public","private"]},"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.","enum":[true,false]}}},"example":{"allow_auto_merge":"","allow_forking":"","allow_merge_commit":"","allow_rebase_merge":"","allow_squash_merge":"","allow_update_branch":"","archived":"","default_branch":"","delete_branch_on_merge":"","description":"","has_issues":"","has_projects":"","has_pull_requests":"","has_wiki":"","homepage":"","is_template":"","merge_commit_message":"","merge_commit_title":"","name":"","private":"","pull_request_creation_policy":"","security_and_analysis":{},"squash_merge_commit_message":"","squash_merge_commit_title":"","use_squash_pr_title_as_default":"","visibility":"","web_commit_signoff_required":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#delete-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}"},"summary":"Delete a repository","description":"Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/artifacts":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"The name field of an artifact. When specified, only artifacts with this name will be returned.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/artifacts"},"summary":"List artifacts for a repository","description":"Lists all artifacts for a repository.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"artifact_id","in":"path","description":"The unique identifier of the artifact.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/artifacts#get-an-artifact","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/artifacts/{artifact_id}"},"summary":"Get an artifact","description":"Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Actions"],"parameters":[{"name":"artifact_id","in":"path","description":"The unique identifier of the artifact.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/artifacts#delete-an-artifact","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/artifacts/{artifact_id}"},"summary":"Delete an artifact","description":"Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}":{"get":{"tags":["Actions"],"parameters":[{"name":"archive_format","in":"path","description":"archive_format","required":true,"schema":{"type":"string","example":""}},{"name":"artifact_id","in":"path","description":"The unique identifier of the artifact.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/artifacts#download-an-artifact","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"},"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\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/cache/retention-limit":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/cache/retention-limit"},"summary":"Get GitHub Actions cache retention limit for a repository","description":"Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/cache/retention-limit"},"summary":"Set GitHub Actions cache retention limit for a repository","description":"Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_cache_retention_days":{"type":"number","description":"The maximum number of days to keep caches in this repository."}}},"example":{"max_cache_retention_days":""}}}}}},"/repos/{owner}/{repo}/actions/cache/storage-limit":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/cache/storage-limit"},"summary":"Get GitHub Actions cache storage limit for a repository","description":"Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/cache/storage-limit"},"summary":"Set GitHub Actions cache storage limit for a repository","description":"Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_cache_size_gb":{"type":"number","description":"The maximum total cache size for this repository, in gigabytes."}}},"example":{"max_cache_size_gb":""}}}}}},"/repos/{owner}/{repo}/actions/cache/usage":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/cache/usage"},"summary":"Get GitHub Actions cache usage for a repository","description":"Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/caches":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"key","in":"query","description":"An explicit key or prefix for identifying the cache","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"ref","in":"query","description":"The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created_at","last_accessed_at","size_in_bytes"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/caches"},"summary":"List GitHub Actions caches for a repository","description":"Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"key","in":"query","description":"A key for identifying the cache.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"query","description":"The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/caches"},"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.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/caches/{cache_id}":{"delete":{"tags":["Actions"],"parameters":[{"name":"cache_id","in":"path","description":"The unique identifier of the GitHub Actions cache.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/caches/{cache_id}"},"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.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/concurrency_groups":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/concurrency_groups"},"summary":"List concurrency groups for a repository","description":"Lists the active concurrency groups for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}":{"get":{"tags":["Actions"],"parameters":[{"name":"concurrency_group_name","in":"path","description":"The name of the concurrency group.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ahead_of_job","in":"query","description":"Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with `ahead_of_run`.","schema":{"type":"number","example":""}},{"name":"ahead_of_run","in":"query","description":"Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with `ahead_of_job`.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/concurrency-groups#get-a-concurrency-group-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}"},"summary":"Get a concurrency group for a repository","description":"Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.\n\nOptionally, pass `ahead_of_run` or `ahead_of_job` to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.\n\nWhen using `ahead_of_run`, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use `ahead_of_job` to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/jobs/{job_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"job_id","in":"path","description":"The unique identifier of the job.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/jobs/{job_id}"},"summary":"Get a job for a workflow run","description":"Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/jobs/{job_id}/logs":{"get":{"tags":["Actions"],"parameters":[{"name":"job_id","in":"path","description":"The unique identifier of the job.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/jobs/{job_id}/logs"},"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\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun":{"post":{"tags":["Actions"],"parameters":[{"name":"job_id","in":"path","description":"The unique identifier of the job.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun"},"summary":"Re-run a job from a workflow run","description":"Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enable_debug_logging":{"type":"boolean","description":"Whether to enable debug logging for the re-run.","enum":[true,false]},"enable_debugger":{"type":"boolean","description":"Whether to enable the debugger for the re-run of this job.","enum":[true,false]}}},"example":{"enable_debug_logging":"","enable_debugger":""}}}}}},"/repos/{owner}/{repo}/actions/oidc/customization/sub":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/oidc/customization/sub"},"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.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/oidc/customization/sub"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"include_claim_keys":{"type":"array","description":"Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.","items":{"type":"string"}},"use_default":{"type":"boolean","description":"Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.","required":true,"enum":[true,false]},"use_immutable_subject":{"type":"boolean","description":"Whether to opt in to the immutable OIDC subject claim format for this repository. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim.","enum":[true,false]}}},"example":{"include_claim_keys":[],"use_default":"","use_immutable_subject":""}}}}}},"/repos/{owner}/{repo}/actions/organization-secrets":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/organization-secrets"},"summary":"List repository organization secrets","description":"Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/organization-variables":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#list-repository-organization-variables","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/organization-variables"},"summary":"List repository organization variables","description":"Lists all organization variables shared with a repository.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/permissions":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions"},"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.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions"},"summary":"Set GitHub Actions permissions for a repository","description":"Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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"]},"enabled":{"type":"boolean","description":"Whether GitHub Actions is enabled on the repository.","required":true,"enum":[true,false]},"sha_pinning_required":{"type":"boolean","description":"Whether actions must be pinned to a full-length commit SHA.","enum":[true,false]}}},"example":{"allowed_actions":"","enabled":"","sha_pinning_required":""}}}}}},"/repos/{owner}/{repo}/actions/permissions/access":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/access"},"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.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/access"},"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.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/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)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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\nrepository.\n\n`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.","required":true,"enum":["none","user","organization"]}}},"example":{"access_level":""}}}}}},"/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention"},"summary":"Get artifact and log retention settings for a repository","description":"Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention"},"summary":"Set artifact and log retention settings for a repository","description":"Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"days":{"type":"number","description":"The number of days to retain artifacts and logs","required":true}}},"example":{"days":""}}}}}},"/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval"},"summary":"Get fork PR contributor approval permissions for a repository","description":"Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval"},"summary":"Set fork PR contributor approval permissions for a repository","description":"Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"approval_policy":{"type":"string","description":"The policy that controls when fork PR workflows require approval from a maintainer.","required":true,"enum":["first_time_contributors_new_to_github","first_time_contributors","all_external_contributors"]}}},"example":{"approval_policy":""}}}}}},"/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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.","enum":[true,false]},"run_workflows_from_fork_pull_requests":{"type":"boolean","description":"Whether workflows triggered by pull requests from forks are allowed to run on private repositories.","required":true,"enum":[true,false]},"send_secrets_and_variables":{"type":"boolean","description":"Whether to make secrets and variables available to workflows triggered by pull requests from forks.","enum":[true,false]},"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.","enum":[true,false]}}},"example":{"require_approval_for_fork_pr_workflows":"","run_workflows_from_fork_pull_requests":"","send_secrets_and_variables":"","send_write_tokens_to_workflows":""}}}}}},"/repos/{owner}/{repo}/actions/permissions/selected-actions":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/selected-actions"},"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).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/selected-actions"},"summary":"Set allowed actions and reusable workflows for a repository","description":"Sets the actions and reusable workflows 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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"github_owned_allowed":{"type":"boolean","description":"Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.","enum":[true,false]},"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/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.","items":{"type":"string"}},"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.","enum":[true,false]}}},"example":{"github_owned_allowed":"","patterns_allowed":[],"verified_allowed":""}}}}}},"/repos/{owner}/{repo}/actions/permissions/workflow":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/workflow"},"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,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/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).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/permissions/workflow"},"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\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"can_approve_pull_request_reviews":{"type":"boolean","description":"Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.","enum":[true,false]},"default_workflow_permissions":{"type":"string","description":"The default workflow permissions granted to the GITHUB_TOKEN when running workflows.","enum":["read","write"]}}},"example":{"can_approve_pull_request_reviews":"","default_workflow_permissions":""}}}}}},"/repos/{owner}/{repo}/actions/runners":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"The name of a self-hosted runner.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners"},"summary":"List self-hosted runners for a repository","description":"Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runners/deprecations/{version}":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"version","in":"path","description":"The runner version to look up.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#get-runner-version-end-of-life-schedule-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/deprecations/{version}"},"summary":"Get runner version end-of-life schedule for a repository","description":"Gets the end-of-life schedule for a specific runner version in a repository. Returns the runner version\nand the dates when registration and runtime support will end.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runners/downloads":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/downloads"},"summary":"List runner applications for a repository","description":"Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runners/generate-jitconfig":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/generate-jitconfig"},"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.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.","required":true,"items":{"type":"string"}},"name":{"type":"string","description":"The name of the new runner.","required":true},"runner_group_id":{"type":"number","description":"The ID of the runner group to register the runner to.","required":true},"work_folder":{"type":"string","description":"The working directory to be used for job execution, relative to the runner install directory."}}},"example":{"labels":[],"name":"","runner_group_id":"","work_folder":""}}}}}},"/repos/{owner}/{repo}/actions/runners/registration-token":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/registration-token"},"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.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runners/remove-token":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/remove-token"},"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.\n\nFor 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:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runners/{runner_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/{runner_id}"},"summary":"Get a self-hosted runner for a repository","description":"Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/{runner_id}"},"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.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/{runner_id}/labels"},"summary":"List labels for a self-hosted runner for a repository","description":"Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/{runner_id}/labels"},"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.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"The names of the custom labels to add to the runner.","required":true,"items":{"type":"string"}}}},"example":{"labels":[]}}}}},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/{runner_id}/labels"},"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\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.","required":true,"items":{"type":"string"}}}},"example":{"labels":[]}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/{runner_id}/labels"},"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\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}":{"delete":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of a self-hosted runner's custom label.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"runner_id","in":"path","description":"Unique identifier of the self-hosted runner.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}"},"summary":"Remove a custom label from a self-hosted runner for a repository","description":"Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runs":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"actor","in":"query","description":"Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.","schema":{"type":"string","example":""}},{"name":"branch","in":"query","description":"Returns workflow runs associated with a branch. Use the name of the branch of the `push`.","schema":{"type":"string","example":""}},{"name":"check_suite_id","in":"query","description":"Returns workflow runs with the `check_suite_id` that you specify.","schema":{"type":"number","example":""}},{"name":"created","in":"query","description":"Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"","schema":{"type":"string","example":""}},{"name":"event","in":"query","description":"Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"","schema":{"type":"string","example":""}},{"name":"exclude_pull_requests","in":"query","description":"If `true` pull requests are omitted from the response (empty array).","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"head_sha","in":"query","description":"Only returns workflow runs that are associated with the specified `head_sha`.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["completed","action_required","cancelled","failure","neutral","skipped","stale","success","timed_out","in_progress","queued","requested","waiting","pending"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs"},"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/rest/guides/getting-started-with-the-rest-api#parameters).\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.\n\nThis 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`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runs/{run_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"exclude_pull_requests","in":"query","description":"If `true` pull requests are omitted from the response (empty array).","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}"},"summary":"Get a workflow run","description":"Gets a specific workflow run.\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.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}"},"summary":"Delete a workflow run","description":"Deletes a specific workflow run.\n\nAnyone with write access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/approvals":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/approvals"},"summary":"Get the review history for a workflow run","description":"Anyone 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runs/{run_id}/approve":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/approve"},"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/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"name","in":"query","description":"The name field of an artifact. When specified, only artifacts with this name will be returned.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"},"summary":"List workflow run artifacts","description":"Lists artifacts for a workflow run.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}":{"get":{"tags":["Actions"],"parameters":[{"name":"attempt_number","in":"path","description":"The attempt number of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"exclude_pull_requests","in":"query","description":"If `true` pull requests are omitted from the response (empty array).","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}"},"summary":"Get a workflow run attempt","description":"Gets a specific workflow run attempt.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs":{"get":{"tags":["Actions"],"parameters":[{"name":"attempt_number","in":"path","description":"The attempt number of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs"},"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\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs":{"get":{"tags":["Actions"],"parameters":[{"name":"attempt_number","in":"path","description":"The attempt number of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs"},"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\n1 minute. Look for `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/cancel"},"summary":"Cancel a workflow run","description":"Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/concurrency-groups#list-concurrency-groups-for-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups"},"summary":"List concurrency groups for a workflow run","description":"Lists all concurrency groups associated with a workflow run or its jobs.\n\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the `group_members` array will be empty.\n`total_count` reflects the number of groups the run participates in by\nconfiguration, not the number with active items.\n\nThis differs from `GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name}`,\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.\n\nResults are sorted by group name and support cursor-based pagination via\n`before` and `after`. The `after` cursor paginates forward only and does\nnot emit a `rel=\"prev\"` Link; use `before` to page backward from a\nforward page's `next` cursor.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule"},"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/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> 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).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"Comment associated with the pending deployment protection rule. **Required when state is not provided.**","required":true},"environment_name":{"type":"string","description":"The name of the environment to approve or reject.","required":true}}},"example":{"comment":"","environment_name":""}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel"},"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.\nYou 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).\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}},{"name":"filter","in":"query","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.","schema":{"type":"string","example":"","items":{"type":"string","enum":["latest","all"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/jobs"},"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\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/runs/{run_id}/logs":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/logs"},"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\n`Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/logs"},"summary":"Delete workflow run logs","description":"Deletes all logs for a workflow run.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"},"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.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"},"summary":"Review pending deployments for a workflow run","description":"Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"A comment to accompany the deployment review","required":true},"environment_ids":{"type":"array","description":"The list of environment ids to approve or reject","required":true,"items":{"type":"number"}},"state":{"type":"string","description":"Whether to approve or reject deployment to the specified environments.","required":true,"enum":["approved","rejected"]}}},"example":{"comment":"","environment_ids":[],"state":""}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/rerun"},"summary":"Re-run a workflow","description":"Re-runs your workflow run using its `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enable_debug_logging":{"type":"boolean","description":"Whether to enable debug logging for the re-run.","enum":[true,false]}}},"example":{"enable_debug_logging":""}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enable_debug_logging":{"type":"boolean","description":"Whether to enable debug logging for the re-run.","enum":[true,false]}}},"example":{"enable_debug_logging":""}}}}}},"/repos/{owner}/{repo}/actions/runs/{run_id}/timing":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"run_id","in":"path","description":"The unique identifier of the workflow run.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/runs/{run_id}/timing"},"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-hosted runners. Usage is listed for each GitHub-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/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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/secrets":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#list-repository-secrets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/secrets"},"summary":"List repository secrets","description":"Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/secrets/public-key":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#get-a-repository-public-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/secrets/public-key"},"summary":"Get a repository public key","description":"Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/secrets/{secret_name}":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#get-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/secrets/{secret_name}"},"summary":"Get a repository secret","description":"Gets a single repository secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/secrets/{secret_name}"},"summary":"Create or update a repository secret","description":"Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/actions/secrets#get-a-repository-public-key) endpoint.","required":true},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret.","required":true}}},"example":{"encrypted_value":"","key_id":""}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#delete-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/secrets/{secret_name}"},"summary":"Delete a repository secret","description":"Deletes a secret in a repository using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/variables":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#list-repository-variables","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/variables"},"summary":"List repository variables","description":"Lists all repository variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#create-a-repository-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/variables"},"summary":"Create a repository variable","description":"Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable.","required":true},"value":{"type":"string","description":"The value of the variable.","required":true}}},"example":{"name":"","value":""}}}}}},"/repos/{owner}/{repo}/actions/variables/{name}":{"get":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#get-a-repository-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/variables/{name}"},"summary":"Get a repository variable","description":"Gets a specific variable in a repository.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#update-a-repository-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/variables/{name}"},"summary":"Update a repository variable","description":"Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable."},"value":{"type":"string","description":"The value of the variable."}}},"example":{"name":"","value":""}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#delete-a-repository-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/variables/{name}"},"summary":"Delete a repository variable","description":"Deletes a repository variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/workflows":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflows#list-repository-workflows","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/workflows"},"summary":"List repository workflows","description":"Lists the workflows in a repository.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/workflows/{workflow_id}":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"workflow_id","in":"path","description":"The ID of the workflow. You can also pass the workflow file name as a string.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflows#get-a-workflow","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflow_id}"},"summary":"Get a workflow","description":"Gets a specific workflow. You can replace `workflow_id` with the workflow\nfile 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable":{"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"workflow_id","in":"path","description":"The ID of the workflow. You can also pass the workflow file name as a string.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflows#disable-a-workflow","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"},"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`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches":{"post":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"workflow_id","in":"path","description":"The ID of the workflow. You can also pass the workflow file name as a string.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches"},"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`.\n\nYou 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).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"object","description":"Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted.","properties":{}},"ref":{"type":"string","description":"The git reference for the workflow. The reference can be a branch or tag name.","required":true}}},"example":{"inputs":{},"ref":""}}}}}},"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable":{"put":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"workflow_id","in":"path","description":"The ID of the workflow. You can also pass the workflow file name as a string.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflows#enable-a-workflow","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"},"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`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"workflow_id","in":"path","description":"The ID of the workflow. You can also pass the workflow file name as a string.","required":true,"schema":{"type":"number","example":""}},{"name":"actor","in":"query","description":"Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.","schema":{"type":"string","example":""}},{"name":"branch","in":"query","description":"Returns workflow runs associated with a branch. Use the name of the branch of the `push`.","schema":{"type":"string","example":""}},{"name":"check_suite_id","in":"query","description":"Returns workflow runs with the `check_suite_id` that you specify.","schema":{"type":"number","example":""}},{"name":"created","in":"query","description":"Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"","schema":{"type":"string","example":""}},{"name":"event","in":"query","description":"Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"","schema":{"type":"string","example":""}},{"name":"exclude_pull_requests","in":"query","description":"If `true` pull requests are omitted from the response (empty array).","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"head_sha","in":"query","description":"Only returns workflow runs that are associated with the specified `head_sha`.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["completed","action_required","cancelled","failure","neutral","skipped","stale","success","timed_out","in_progress","queued","requested","waiting","pending"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"},"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/rest/guides/getting-started-with-the-rest-api#parameters).\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.\n\nThis 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`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing":{"get":{"tags":["Actions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"workflow_id","in":"path","description":"The ID of the workflow. You can also pass the workflow file name as a string.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/workflows#get-workflow-usage","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"},"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-hosted runners. Usage is listed for each GitHub-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/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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/activity":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"activity_type","in":"query","description":"The activity type to filter by.\n\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.","schema":{"type":"string","example":"","items":{"type":"string","enum":["push","force_push","branch_creation","branch_deletion","pr_merge","merge_queue_merge"]}}},{"name":"actor","in":"query","description":"The GitHub username to use to filter by the actor who performed the activity.","schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"ref","in":"query","description":"The Git reference for the activities you want to list.\n\nThe `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.","schema":{"type":"string","example":""}},{"name":"time_period","in":"query","description":"The time period to filter by.\n\nFor 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).","schema":{"type":"string","example":"","items":{"type":"string","enum":["day","week","month","quarter","year"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-repository-activities","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/activity"},"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.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).\"","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/agents/organization-secrets":{"get":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#list-repository-organization-secrets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/organization-secrets"},"summary":"List repository organization secrets","description":"Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/agents/organization-variables":{"get":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#list-repository-organization-variables","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/organization-variables"},"summary":"List repository organization variables","description":"Lists all organization variables shared with a repository.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/agents/secrets":{"get":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#list-repository-secrets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/secrets"},"summary":"List repository secrets","description":"Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/agents/secrets/public-key":{"get":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#get-a-repository-public-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/secrets/public-key"},"summary":"Get a repository public key","description":"Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/agents/secrets/{secret_name}":{"get":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#get-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/secrets/{secret_name}"},"summary":"Get a repository secret","description":"Gets a single repository secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#create-or-update-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/secrets/{secret_name}"},"summary":"Create or update a repository secret","description":"Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/agents/secrets#get-a-repository-public-key) endpoint.","required":true},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret.","required":true}}},"example":{"encrypted_value":"","key_id":""}}}}},"delete":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/secrets#delete-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/secrets/{secret_name}"},"summary":"Delete a repository secret","description":"Deletes a secret in a repository using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/agents/variables":{"get":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#list-repository-variables","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/variables"},"summary":"List repository variables","description":"Lists all repository variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Agents"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#create-a-repository-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/variables"},"summary":"Create a repository variable","description":"Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable.","required":true},"value":{"type":"string","description":"The value of the variable.","required":true}}},"example":{"name":"","value":""}}}}}},"/repos/{owner}/{repo}/agents/variables/{name}":{"get":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#get-a-repository-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/variables/{name}"},"summary":"Get a repository variable","description":"Gets a specific variable in a repository.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#update-a-repository-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/variables/{name}"},"summary":"Update a repository variable","description":"Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable."},"value":{"type":"string","description":"The value of the variable."}}},"example":{"name":"","value":""}}}}},"delete":{"tags":["Agents"],"parameters":[{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/agents/variables#delete-a-repository-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/agents/variables/{name}"},"summary":"Delete a repository variable","description":"Deletes a repository variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/assignees":{"get":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/assignees#list-assignees","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/assignees"},"summary":"List assignees","description":"Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/assignees/{assignee}":{"get":{"tags":["Issues"],"parameters":[{"name":"assignee","in":"path","description":"assignee","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/assignees/{assignee}"},"summary":"Check if a user can be assigned","description":"Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/attestations":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/attestations#create-an-attestation","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/attestations"},"summary":"Create an attestation","description":"Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact 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/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bundle":{"type":"object","description":"The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information.","required":true,"properties":{"dsseEnvelope":{"type":"object","description":"dsseEnvelope"},"mediaType":{"type":"string","description":"mediaType"},"verificationMaterial":{"type":"object","description":"verificationMaterial"}}}}},"example":{"bundle":{}}}}}}},"/repos/{owner}/{repo}/attestations/{subject_digest}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"subject_digest","in":"path","description":"The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"predicate_type","in":"query","description":"Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/attestations#list-attestations","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/attestations/{subject_digest}"},"summary":"List attestations","description":"List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe 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.\n\n**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/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/autolinks":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Page number of the results to fetch","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/autolinks"},"summary":"Get all autolinks of a repository","description":"Gets all autolinks that are configured for a repository.\n\nInformation about autolinks are only available to repository administrators.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/autolinks"},"summary":"Create an autolink reference for a repository","description":"Users with admin access to the repository can create an autolink.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"is_alphanumeric":{"type":"boolean","description":"Whether this autolink reference matches alphanumeric characters. If true, the `<num>` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters.","enum":[true,false]},"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.","required":true},"url_template":{"type":"string","description":"The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`.","required":true}}},"example":{"is_alphanumeric":"","key_prefix":"","url_template":""}}}}}},"/repos/{owner}/{repo}/autolinks/{autolink_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"autolink_id","in":"path","description":"The unique identifier of the autolink.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/autolinks/{autolink_id}"},"summary":"Get an autolink reference of a repository","description":"This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Repos"],"parameters":[{"name":"autolink_id","in":"path","description":"The unique identifier of the autolink.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/autolinks/{autolink_id}"},"summary":"Delete an autolink reference from a repository","description":"This deletes a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/automated-security-fixes":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/automated-security-fixes"},"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/articles/configuring-automated-security-fixes)\".","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/automated-security-fixes"},"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/articles/configuring-automated-security-fixes)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/automated-security-fixes"},"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/articles/configuring-automated-security-fixes)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/branches":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"protected","in":"query","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.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branches#list-branches","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches"},"summary":"List branches","description":"List branches","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/branches/{branch}":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branches#get-a-branch","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}"},"summary":"Get a branch","description":"Get a branch","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/branches/{branch}/protection":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-branch-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#update-branch-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.","enum":[true,false]},"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/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"","enum":[true,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`.","enum":[true,false]},"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`.","enum":[true,false]},"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.","required":true,"enum":[true,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`.","enum":[true,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`.","enum":[true,false]},"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/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.","enum":[true,false]},"required_pull_request_reviews":{"type":"object","description":"Require at least one approving review on a pull request, before merging. Set to `null` to disable.","required":true,"properties":{"bypass_pull_request_allowances":{"type":"object","description":"Allow specific users, teams, or apps to bypass pull request requirements."},"dismiss_stale_reviews":{"type":"boolean","description":"Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.","enum":[true,false]},"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."},"require_code_owner_reviews":{"type":"boolean","description":"Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.","enum":[true,false]},"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`.","enum":[true,false]},"required_approving_review_count":{"type":"number","description":"Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers."}}},"required_status_checks":{"type":"object","description":"Require status checks to pass before merging. Set to `null` to disable.","required":true,"properties":{"checks":{"type":"array","description":"The list of status checks to require in order to merge into this branch."},"contexts":{"type":"array","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.","required":true},"strict":{"type":"boolean","description":"Require branches to be up to date before merging.","required":true,"enum":[true,false]}}},"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.","required":true,"properties":{"apps":{"type":"array","description":"The list of app `slug`s with push access"},"teams":{"type":"array","description":"The list of team `slug`s with push access","required":true},"users":{"type":"array","description":"The list of user `login`s with push access","required":true}}}}},"example":{"allow_deletions":"","allow_force_pushes":"","allow_fork_syncing":"","block_creations":"","enforce_admins":"","lock_branch":"","required_conversation_resolution":"","required_linear_history":"","required_pull_request_reviews":{},"required_status_checks":{},"restrictions":{}}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#delete-branch-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bypass_pull_request_allowances":{"type":"object","description":"Allow specific users, teams, or apps to bypass pull request requirements.","properties":{"apps":{"type":"array","description":"The list of app `slug`s allowed to bypass pull request requirements."},"teams":{"type":"array","description":"The list of team `slug`s allowed to bypass pull request requirements."},"users":{"type":"array","description":"The list of user `login`s allowed to bypass pull request requirements."}}},"dismiss_stale_reviews":{"type":"boolean","description":"Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.","enum":[true,false]},"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":{"apps":{"type":"array","description":"The list of app `slug`s with dismissal access"},"teams":{"type":"array","description":"The list of team `slug`s with dismissal access"},"users":{"type":"array","description":"The list of user `login`s with dismissal access"}}},"require_code_owner_reviews":{"type":"boolean","description":"Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.","enum":[true,false]},"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`","enum":[true,false]},"required_approving_review_count":{"type":"number","description":"Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers."}}},"example":{"bypass_pull_request_allowances":{},"dismiss_stale_reviews":"","dismissal_restrictions":{},"require_code_owner_reviews":"","require_last_push_approval":"","required_approving_review_count":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen 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/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#update-status-check-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"checks":{"type":"array","description":"The list of status checks to require in order to merge into this branch.","items":{"type":"object","properties":{"app_id":{"type":"number","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."},"context":{"type":"string","description":"The name of the required check","required":true}}}},"contexts":{"type":"array","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"}},"strict":{"type":"boolean","description":"Require branches to be up to date before merging.","enum":[true,false]}}},"example":{"checks":[],"contexts":[],"strict":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contexts":{"type":"array","description":"The name of the status checks","required":true,"items":{"type":"string"}}}},"example":{"contexts":[]}}}}},"put":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contexts":{"type":"array","description":"The name of the status checks","required":true,"items":{"type":"string"}}}},"example":{"contexts":[]}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contexts":{"type":"array","description":"The name of the status checks","required":true,"items":{"type":"string"}}}},"example":{"contexts":[]}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists 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.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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.","required":true,"items":{"type":"string"}}}},"example":{"apps":[]}}}}},"put":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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.","required":true,"items":{"type":"string"}}}},"example":{"apps":[]}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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.","required":true,"items":{"type":"string"}}}},"example":{"apps":[]}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"teams":{"type":"array","description":"The slug values for teams","required":true,"items":{"type":"string"}}}},"example":{"teams":[]}}}}},"put":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"teams":{"type":"array","description":"The slug values for teams","required":true,"items":{"type":"string"}}}},"example":{"teams":[]}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"teams":{"type":"array","description":"The slug values for teams","required":true,"items":{"type":"string"}}}},"example":{"teams":[]}}}}}},"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type    | Description                                                                                                                   |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"users":{"type":"array","description":"The username for users","required":true,"items":{"type":"string"}}}},"example":{"users":[]}}}}},"put":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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.\n\n| Type    | Description                                                                                                                   |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"users":{"type":"array","description":"The username for users","required":true,"items":{"type":"string"}}}},"example":{"users":[]}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type    | Description                                                                                                                                   |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `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. |","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"users":{"type":"array","description":"The username for users","required":true,"items":{"type":"string"}}}},"example":{"users":[]}}}}}},"/repos/{owner}/{repo}/branches/{branch}/rename":{"post":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branches#rename-a-branch","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/branches/{branch}/rename"},"summary":"Rename a branch","description":"Renames a branch in a repository.\n\n> [!NOTE]\n> 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/github/administering-a-repository/renaming-a-branch)\".\n\nThe 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.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"new_name":{"type":"string","description":"The new name of the branch.","required":true}}},"example":{"new_name":""}}}}}},"/repos/{owner}/{repo}/check-runs":{"post":{"tags":["Checks"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/runs#create-a-check-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-runs"},"summary":"Create a check run","description":"Creates a new check run for a specific commit in a repository.\n\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.\n\nIn 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.\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/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/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"","items":{"type":"object","properties":{"description":{"type":"string","description":"A short explanation of what this action would do. The maximum size is 40 characters.","required":true},"identifier":{"type":"string","description":"A reference for the action on the integrator's system. The maximum size is 20 characters.","required":true},"label":{"type":"string","description":"The text to be displayed on a button in the web UI. The maximum size is 20 characters.","required":true}}}},"completed_at":{"type":"string","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`."},"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"]},"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."},"head_sha":{"type":"string","description":"The SHA of the commit.","required":true},"name":{"type":"string","description":"The name of the check. For example, \"code-coverage\".","required":true},"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":{"text":{"type":"string","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/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/articles/about-status-checks#checks)\"."},"images":{"type":"array","description":"Adds images to the output displayed in the GitHub pull request UI."},"summary":{"type":"string","description":"The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.","required":true},"title":{"type":"string","description":"The title of the check run.","required":true}}},"started_at":{"type":"string","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`."},"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"]}}},"example":{"actions":[],"completed_at":"","conclusion":"","details_url":"","external_id":"","head_sha":"","name":"","output":{},"started_at":"","status":""}}}}}},"/repos/{owner}/{repo}/check-runs/{check_run_id}":{"get":{"tags":["Checks"],"parameters":[{"name":"check_run_id","in":"path","description":"The unique identifier of the check run.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/runs#get-a-check-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-runs/{check_run_id}"},"summary":"Get a check run","description":"Gets a single check run using its `id`.\n\n> [!NOTE]\n> 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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Checks"],"parameters":[{"name":"check_run_id","in":"path","description":"The unique identifier of the check run.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/runs#update-a-check-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-runs/{check_run_id}"},"summary":"Update a check run","description":"Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> 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.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"","items":{"type":"object","properties":{"description":{"type":"string","description":"A short explanation of what this action would do. The maximum size is 40 characters.","required":true},"identifier":{"type":"string","description":"A reference for the action on the integrator's system. The maximum size is 20 characters.","required":true},"label":{"type":"string","description":"The text to be displayed on a button in the web UI. The maximum size is 20 characters.","required":true}}}},"completed_at":{"type":"string","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`."},"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"]},"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."},"name":{"type":"string","description":"The name of the check. For example, \"code-coverage\"."},"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":{"text":{"type":"string","description":"Can contain Markdown."},"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/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/articles/about-status-checks#checks)\"."},"images":{"type":"array","description":"Adds images to the output displayed in the GitHub pull request UI."},"summary":{"type":"string","description":"Can contain Markdown.","required":true},"title":{"type":"string","description":"**Required**."}}},"started_at":{"type":"string","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"]}}},"example":{"actions":[],"completed_at":"","conclusion":"","details_url":"","external_id":"","name":"","output":{},"started_at":"","status":""}}}}}},"/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations":{"get":{"tags":["Checks"],"parameters":[{"name":"check_run_id","in":"path","description":"The unique identifier of the check run.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/runs#list-check-run-annotations","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"},"summary":"List check run annotations","description":"Lists annotations for a check run using the annotation `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest":{"post":{"tags":["Checks"],"parameters":[{"name":"check_run_id","in":"path","description":"The unique identifier of the check run.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/runs#rerequest-a-check-run","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest"},"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/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/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/rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/check-suites":{"post":{"tags":["Checks"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/suites#create-a-check-suite","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-suites"},"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/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/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> 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`.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"head_sha":{"type":"string","description":"The sha of the head commit.","required":true}}},"example":{"head_sha":""}}}}}},"/repos/{owner}/{repo}/check-suites/preferences":{"patch":{"tags":["Checks"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-suites/preferences"},"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/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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":"number","description":"The `id` of the GitHub App.","required":true},"setting":{"type":"boolean","description":"Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.","required":true,"enum":[true,false]}}}}}},"example":{"auto_trigger_checks":[]}}}}}},"/repos/{owner}/{repo}/check-suites/{check_suite_id}":{"get":{"tags":["Checks"],"parameters":[{"name":"check_suite_id","in":"path","description":"The unique identifier of the check suite.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/suites#get-a-check-suite","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-suites/{check_suite_id}"},"summary":"Get a check suite","description":"Gets a single check suite using its `id`.\n\n> [!NOTE]\n> 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs":{"get":{"tags":["Checks"],"parameters":[{"name":"check_suite_id","in":"path","description":"The unique identifier of the check suite.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"check_name","in":"query","description":"Returns check runs with the specified `name`.","schema":{"type":"string","example":""}},{"name":"filter","in":"query","description":"Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.","schema":{"type":"string","example":"","items":{"type":"string","enum":["latest","all"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"Returns check runs with the specified `status`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["queued","in_progress","completed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"},"summary":"List check runs in a check suite","description":"Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> 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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest":{"post":{"tags":["Checks"],"parameters":[{"name":"check_suite_id","in":"path","description":"The unique identifier of the check suite.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/suites#rerequest-a-check-suite","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"},"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/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/code-quality/findings":{"get":{"tags":["Code Quality"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"state","in":"query","description":"If specified, only code quality findings with this state will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","dismissed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-quality/code-quality#list-code-quality-findings-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-quality/findings"},"summary":"List code quality findings for a repository","description":"Lists code quality findings for a repository.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-quality/findings/{finding_number}":{"get":{"tags":["Code Quality"],"parameters":[{"name":"finding_number","in":"path","description":"The number that identifies a finding.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-finding","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-quality/findings/{finding_number}"},"summary":"Get a code quality finding","description":"Gets a single code quality finding.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-quality/setup":{"get":{"tags":["Code Quality"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-setup-configuration","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-quality/setup"},"summary":"Get a code quality setup configuration","description":"Gets a code quality setup configuration.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Code Quality"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-quality/code-quality#update-a-code-quality-setup-configuration","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-quality/setup"},"summary":"Update a code quality setup configuration","description":"Updates a code quality setup configuration.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ai_findings_option":{"type":"string","description":"Whether AI findings run for Code Quality on this repository.","enum":["disabled","on_push"]},"languages":{"type":"array","description":"Languages to be analyzed.","items":{"type":"string"}},"runner_label":{"type":"string","description":"Runner label to be used if the runner type is labeled."},"runner_type":{"type":"string","description":"Runner type to be used.","enum":["standard","labeled"]},"state":{"type":"string","description":"The desired state of code quality setup.","enum":["configured","not-configured"]}}},"example":{"ai_findings_option":"","languages":[],"runner_label":"","runner_type":"","state":""}}}}}},"/repos/{owner}/{repo}/code-scanning/ai-scan":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-ai-scan-enablement-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/ai-scan"},"summary":"Get AI Scan enablement for a repository","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets whether AI Scan is enabled for a repository.\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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#update-ai-scan-enablement-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/ai-scan"},"summary":"Update AI Scan enablement for a repository","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates whether AI Scan is enabled for a repository.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pr_scan":{"type":"string","description":"Whether to enable or disable AI Scan for the repository.","enum":["enabled","disabled"]}}},"example":{"pr_scan":""}}}}}},"/repos/{owner}/{repo}/code-scanning/alerts":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"assignees","in":"query","description":"Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.\n","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"pr","in":"query","description":"The number of the pull request for the results you want to list.","schema":{"type":"number","example":""}},{"name":"ref","in":"query","description":"The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`.","schema":{"type":"string","example":""}},{"name":"severity","in":"query","description":"Severity of a code scanning alert.","schema":{"type":"string","example":"","items":{"type":"string","enum":["critical","high","medium","low","warning","note","error"]}}},{"name":"sort","in":"query","description":"The property by which to sort the results.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}},{"name":"state","in":"query","description":"State of a code scanning alert.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed","dismissed","fixed"]}}},{"name":"tool_guid","in":"query","description":"The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.","schema":{"type":"string","example":""}},{"name":"tool_name","in":"query","description":"The name of the tool used to generate the code scanning analysis.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/alerts"},"summary":"List code scanning alerts for a repository","description":"Lists code scanning alerts.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"},"summary":"Get a code scanning alert","description":"Gets a single code scanning alert.\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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Code Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"},"summary":"Update a code scanning alert","description":"Updates the status of a single code scanning alert.\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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"assignees":{"type":"array","description":"The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.","items":{"type":"string"}},"create_request":{"type":"boolean","description":"If `true`, attempt to create an alert dismissal request.","enum":[true,false]},"dismissed_comment":{"type":"string","description":"The dismissal comment associated with the dismissal of the alert."},"dismissed_reason":{"type":"string","description":"**Required when the state is dismissed.** The reason for dismissing or closing the alert.","enum":["false positive","won't fix","used in tests","mitigated"]},"state":{"type":"string","description":"Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.","enum":["open","dismissed"]}}},"example":{"assignees":[],"create_request":"","dismissed_comment":"","dismissed_reason":"","state":""}}}}}},"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix"},"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 on the repository's default branch.\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.","security":[{"bearerAuth":[]}]},"post":{"tags":["Code Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix"},"summary":"Create an autofix for a code scanning alert","description":"Creates an autofix for a code scanning alert from the repository's default branch.\n\nIf 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.\n\nIf an autofix already exists for a given alert, then this endpoint will return a 200 OK response.\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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits":{"post":{"tags":["Code Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits"},"summary":"Commit an autofix for a code scanning alert","description":"Commits an autofix for a code scanning alert from the repository's default branch.\n\nIf an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"Commit message to be used."},"target_ref":{"type":"string","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."}}},"example":{"message":"","target_ref":""}}}}}},"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"pr","in":"query","description":"The number of the pull request for the results you want to list.","schema":{"type":"number","example":""}},{"name":"ref","in":"query","description":"The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"},"summary":"List instances of a code scanning alert","description":"Lists all instances of the specified code scanning alert.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-scanning/analyses":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"pr","in":"query","description":"The number of the pull request for the results you want to list.","schema":{"type":"number","example":""}},{"name":"ref","in":"query","description":"The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`.","schema":{"type":"string","example":""}},{"name":"sarif_id","in":"query","description":"An identifier for the upload.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property by which to sort the results.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created"]}}},{"name":"tool_guid","in":"query","description":"The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.","schema":{"type":"string","example":""}},{"name":"tool_name","in":"query","description":"The name of the tool used to generate the code scanning analysis.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/analyses"},"summary":"List code scanning analyses for a repository","description":"Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **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.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}":{"get":{"tags":["Code Scanning"],"parameters":[{"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":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}"},"summary":"Get a code scanning analysis for a repository","description":"Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\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.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Code Scanning"],"parameters":[{"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":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"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.`","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}"},"summary":"Delete a code scanning analysis from a repository","description":"Deletes a specified code scanning analysis from a repository.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n  **Inner loop**:\n  * Delete the identified analysis.\n  * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe 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.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/code-scanning/codeql/databases":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/codeql/databases"},"summary":"List CodeQL databases for a repository","description":"Lists the CodeQL databases that are available in a repository.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"language","in":"path","description":"The language of the CodeQL database.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}"},"summary":"Get a CodeQL database for a repository","description":"Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Code Scanning"],"parameters":[{"name":"language","in":"path","description":"The language of the CodeQL database.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}"},"summary":"Delete a CodeQL database","description":"Deletes a CodeQL database for a language in a repository.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses":{"post":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses"},"summary":"Create a CodeQL variant analysis","description":"Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"language":{"type":"string","description":"The language targeted by the CodeQL query","required":true,"enum":["actions","cpp","csharp","go","java","javascript","python","ruby","rust","swift"]},"query_pack":{"type":"string","description":"A Base64-encoded tarball containing a CodeQL query and all its dependencies","required":true},"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":{"type":"array","description":"List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.","items":{"type":"string"}},"repository_owners":{"type":"array","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.","items":{"type":"string"}}}},"example":{"language":"","query_pack":"","repositories":[],"repository_lists":[],"repository_owners":[]}}}}}},"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"codeql_variant_analysis_id","in":"path","description":"The unique identifier of the variant analysis.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}"},"summary":"Get the summary of a CodeQL variant analysis","description":"Gets the summary of a CodeQL variant analysis.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"codeql_variant_analysis_id","in":"path","description":"The ID of the variant analysis.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the controller repository.","required":true,"schema":{"type":"string","example":""}},{"name":"repo_name","in":"path","description":"The name of the variant analysis repository.","required":true,"schema":{"type":"string","example":""}},{"name":"repo_owner","in":"path","description":"The account owner of the variant analysis repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}"},"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.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-scanning/default-setup":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/default-setup"},"summary":"Get a code scanning default setup configuration","description":"Gets a code scanning default setup configuration.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/default-setup"},"summary":"Update a code scanning default setup configuration","description":"Updates a code scanning default setup configuration.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"languages":{"type":"array","description":"CodeQL languages to be analyzed.","items":{"type":"string"}},"query_suite":{"type":"string","description":"CodeQL query suite to be used.","enum":["default","extended"]},"runner_label":{"type":"string","description":"Runner label to be used if the runner type is labeled."},"runner_type":{"type":"string","description":"Runner type to be used.","enum":["standard","labeled"]},"state":{"type":"string","description":"The desired state of code scanning default setup.","enum":["configured","not-configured"]},"threat_model":{"type":"string","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.","enum":["remote","remote_and_local"]}}},"example":{"languages":[],"query_suite":"","runner_label":"","runner_type":"","state":"","threat_model":""}}}}}},"/repos/{owner}/{repo}/code-scanning/sarifs":{"post":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/sarifs"},"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/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/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"checkout_uri":{"type":"string","description":"The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository."},"commit_sha":{"type":"string","description":"The SHA of the commit to which the analysis you are uploading relates.","required":true},"ref":{"type":"string","description":"The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/tags/<tag>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`.","required":true},"sarif":{"type":"string","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/code-security/secure-coding/sarif-support-for-code-scanning).\"","required":true},"started_at":{"type":"string","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`."},"tool_name":{"type":"string","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`."},"validate":{"type":"boolean","description":"Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.","enum":[true,false]}}},"example":{"checkout_uri":"","commit_sha":"","ref":"","sarif":"","started_at":"","tool_name":"","validate":""}}}}}},"/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}":{"get":{"tags":["Code Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"sarif_id","in":"path","description":"The SARIF ID obtained after uploading.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"},"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).\"\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/code-security-configuration":{"get":{"tags":["Code Security"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/code-security-configuration"},"summary":"Get the code security configuration associated with a repository","description":"Get the code security configuration that manages a repository's code security settings.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/codeowners/errors":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"query","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`)","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-codeowners-errors","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codeowners/errors"},"summary":"List CODEOWNERS errors","description":"List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/codespaces":{"get":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces"},"summary":"List codespaces in a repository for the authenticated user","description":"Lists the codespaces associated to a specified repository and the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces"},"summary":"Create a codespace in a repository","description":"Creates a codespace owned by the authenticated user in the specified repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_ip":{"type":"string","description":"IP for location auto-detection when proxying a request"},"devcontainer_path":{"type":"string","description":"Path to devcontainer.json config to use for this codespace"},"display_name":{"type":"string","description":"Display name for this codespace"},"geo":{"type":"string","description":"The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.","enum":["EuropeWest","SoutheastAsia","UsEast","UsWest"]},"idle_timeout_minutes":{"type":"number","description":"Time in minutes before codespace stops from inactivity"},"location":{"type":"string","description":"The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided."},"machine":{"type":"string","description":"Machine type to use for this codespace"},"multi_repo_permissions_opt_out":{"type":"boolean","description":"Whether to authorize requested permissions from devcontainer.json","enum":[true,false]},"ref":{"type":"string","description":"Git ref (typically a branch name) for this codespace"},"retention_period_minutes":{"type":"number","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)."},"working_directory":{"type":"string","description":"Working directory for this codespace"}}},"example":{"client_ip":"","devcontainer_path":"","display_name":"","geo":"","idle_timeout_minutes":"","location":"","machine":"","multi_repo_permissions_opt_out":"","ref":"","retention_period_minutes":"","working_directory":""}}}}}},"/repos/{owner}/{repo}/codespaces/devcontainers":{"get":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/devcontainers"},"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\nspecify launchpoint configurations for codespaces created within the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/codespaces/machines":{"get":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"client_ip","in":"query","description":"IP for location auto-detection when proxying a request","schema":{"type":"string","example":""}},{"name":"location","in":"query","description":"The location to check for available machines. Assigned by IP if not provided.","schema":{"type":"string","example":""}},{"name":"ref","in":"query","description":"The branch or commit to check for prebuild availability and devcontainer restrictions.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/machines"},"summary":"List available machine types for a repository","description":"List the machine types available for a given repository based on its configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/codespaces/new":{"get":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"client_ip","in":"query","description":"An alternative IP for default location auto-detection, such as when proxying a request.","schema":{"type":"string","example":""}},{"name":"ref","in":"query","description":"The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/new"},"summary":"Get default attributes for a codespace","description":"Gets the default attributes for codespaces created by the user with the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/codespaces/permissions_check":{"get":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"devcontainer_path","in":"query","description":"Path to the devcontainer.json configuration to use for the permission check.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"query","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.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/permissions_check"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/codespaces/secrets":{"get":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/secrets"},"summary":"List repository secrets","description":"Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/codespaces/secrets/public-key":{"get":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/secrets/public-key"},"summary":"Get a repository public key","description":"Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/codespaces/secrets/{secret_name}":{"get":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/secrets/{secret_name}"},"summary":"Get a repository secret","description":"Gets a single repository development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/secrets/{secret_name}"},"summary":"Create or update a repository secret","description":"Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint."},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret."}}},"example":{"encrypted_value":"","key_id":""}}}}},"delete":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/codespaces/secrets/{secret_name}"},"summary":"Delete a repository secret","description":"Deletes a development environment secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/collaborators":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"affiliation","in":"query","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.","schema":{"type":"string","example":"","items":{"type":"string","enum":["outside","direct","all"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"permission","in":"query","description":"Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["pull","triage","push","maintain","admin"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/collaborators"},"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.\nThe `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.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe 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.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/collaborators/{username}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/collaborators/{username}"},"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.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/collaborators/{username}"},"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/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.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\n\nAdding 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/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/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)\" for organization settings.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/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:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe 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/rest/collaborators/invitations).\n\nFor 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.\n\n**Updating an existing collaborator's permission level**\n\nThe 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.\n\n**Rate limits**\n\nYou 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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."}}},"example":{"permission":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/collaborators/{username}"},"summary":"Remove a repository collaborator","description":"Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations sent by the collaborator\n- Unassigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/collaborators/{username}/permission":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/collaborators/{username}/permission"},"summary":"Get repository permissions for a user","description":"Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/comments":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/comments"},"summary":"List commit comments for a repository","description":"Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/comments/{comment_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/comments#get-a-commit-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/comments/{comment_id}"},"summary":"Get a commit comment","description":"Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/comments#update-a-commit-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/comments/{comment_id}"},"summary":"Update a commit comment","description":"Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The contents of the comment","required":true}}},"example":{"body":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/comments#delete-a-commit-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/comments/{comment_id}"},"summary":"Delete a commit comment","description":"Delete a commit comment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/comments/{comment_id}/reactions":{"get":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"content","in":"query","description":"Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.","schema":{"type":"string","example":"","items":{"type":"string","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/comments/{comment_id}/reactions"},"summary":"List reactions for a commit comment","description":"List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).","security":[{"bearerAuth":[]}]},"post":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/comments/{comment_id}/reactions"},"summary":"Create reaction for a commit comment","description":"Create a reaction to a [commit comment](https://docs.github.com/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment.","required":true,"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]}}},"example":{"content":""}}}}}},"/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}":{"delete":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"reaction_id","in":"path","description":"The unique identifier of the reaction.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}"},"summary":"Delete a commit comment reaction","description":"> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/commits":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"path","in":"query","description":"Only commits containing this file path will be returned.","schema":{"type":"string","example":""}},{"name":"author","in":"query","description":"GitHub username or email address to use to filter by commit author.","schema":{"type":"string","example":""}},{"name":"committer","in":"query","description":"GitHub username or email address to use to filter by commit committer.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sha","in":"query","description":"SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).","schema":{"type":"string","example":""}},{"name":"since","in":"query","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.","schema":{"type":"string","example":""}},{"name":"until","in":"query","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.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/commits#list-commits","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits"},"summary":"List commits","description":"**Signature verification object**\n\nThe 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:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head":{"get":{"tags":["Repos"],"parameters":[{"name":"commit_sha","in":"path","description":"The SHA of the commit.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/commits#list-branches-for-head-commit","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/commits/{commit_sha}/comments":{"get":{"tags":["Repos"],"parameters":[{"name":"commit_sha","in":"path","description":"The SHA of the commit.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/comments#list-commit-comments","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{commit_sha}/comments"},"summary":"List commit comments","description":"Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"commit_sha","in":"path","description":"The SHA of the commit.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/comments#create-a-commit-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{commit_sha}/comments"},"summary":"Create a commit comment","description":"Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/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/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/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"path":{"type":"string","description":"Relative path of the file to comment on."},"body":{"type":"string","description":"The contents of the comment.","required":true},"line":{"type":"number","description":"**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on."},"position":{"type":"number","description":"Line index in the diff to comment on."}}},"example":{"path":"","body":"","line":"","position":""}}}}}},"/repos/{owner}/{repo}/commits/{commit_sha}/pulls":{"get":{"tags":["Repos"],"parameters":[{"name":"commit_sha","in":"path","description":"The SHA of the commit.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{commit_sha}/pulls"},"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.\n\nTo list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/commits/{ref}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/commits#get-a-commit","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{ref}"},"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.\n\n> [!NOTE]\n> 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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`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.\n- **`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.\n\n**Signature verification object**\n\nThe 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:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/commits/{ref}/check-runs":{"get":{"tags":["Checks"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"app_id","in":"query","description":"app_id","schema":{"type":"number","example":""}},{"name":"check_name","in":"query","description":"Returns check runs with the specified `name`.","schema":{"type":"string","example":""}},{"name":"filter","in":"query","description":"Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.","schema":{"type":"string","example":"","items":{"type":"string","enum":["latest","all"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"Returns check runs with the specified `status`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["queued","in_progress","completed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{ref}/check-runs"},"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.\n\n> [!NOTE]\n> 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.\n\nIf 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/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/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/commits/{ref}/check-suites":{"get":{"tags":["Checks"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"app_id","in":"query","description":"Filters check suites by GitHub App `id`.","schema":{"type":"number","example":""}},{"name":"check_name","in":"query","description":"Returns check runs with the specified `name`.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{ref}/check-suites"},"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.\n\n> [!NOTE]\n> 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/commits/{ref}/status":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{ref}/status"},"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.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n*   **failure** if any of the contexts report as `error` or `failure`\n*   **pending** if there are no statuses or a context is `pending`\n*   **success** if the latest status for all contexts is `success`","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/commits/{ref}/statuses":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/commits/{ref}/statuses"},"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.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/community/profile":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/community#get-community-profile-metrics","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/community/profile"},"summary":"Get community profile metrics","description":"Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/compare/{basehead}":{"get":{"tags":["Repos"],"parameters":[{"name":"basehead","in":"path","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`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/commits#compare-two-commits","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/compare/{basehead}"},"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/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis 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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe 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.\n\nWhen 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.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- 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.\n- 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.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/contents/{path}":{"get":{"tags":["Repos"],"parameters":[{"name":"path","in":"path","description":"path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"query","description":"The name of the commit/branch/tag. Default: the repository’s default branch.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/contents#get-repository-content","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/contents/{path}"},"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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`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).\n- **`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.\n\nIf the content is a directory: The response will be an array of objects, one object for each item in the directory.\n\nIf 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.\n\nIf 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.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).\n- 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.\n- If the requested file's size is:\n  - 1 MB or smaller: All features of this endpoint are supported.\n  - 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\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n  - Greater than 100 MB: This endpoint is not supported.","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"path","in":"path","description":"path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/contents#create-or-update-file-contents","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/contents/{path}"},"summary":"Create or update file contents","description":"Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/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.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"author":{"type":"object","description":"The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.","properties":{"date":{"type":"string","description":"date"},"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.","required":true},"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.","required":true}}},"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":{"date":{"type":"string","description":"date"},"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.","required":true},"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.","required":true}}},"content":{"type":"string","description":"The new file content, using Base64 encoding.","required":true},"message":{"type":"string","description":"The commit message.","required":true},"sha":{"type":"string","description":"**Required if you are updating a file**. The blob SHA of the file being replaced."}}},"example":{"author":{},"branch":"","committer":{},"content":"","message":"","sha":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"path","in":"path","description":"path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/contents#delete-a-file","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/contents/{path}"},"summary":"Delete a file","description":"Deletes a file in a repository.\n\nYou 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.\n\nThe `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.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"author":{"type":"object","description":"object containing information about the author.","properties":{"email":{"type":"string","description":"The email of the author (or committer) of the commit"},"name":{"type":"string","description":"The name of the author (or committer) of the commit"}}},"branch":{"type":"string","description":"The branch name. Default: the repository’s default branch"},"committer":{"type":"object","description":"object containing information about the committer.","properties":{"email":{"type":"string","description":"The email of the author (or committer) of the commit"},"name":{"type":"string","description":"The name of the author (or committer) of the commit"}}},"message":{"type":"string","description":"The commit message.","required":true},"sha":{"type":"string","description":"The blob SHA of the file being deleted.","required":true}}},"example":{"author":{},"branch":"","committer":{},"message":"","sha":""}}}}}},"/repos/{owner}/{repo}/contributors":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"anon","in":"query","description":"Set to `1` or `true` to include anonymous contributors in results.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-repository-contributors","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/contributors"},"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.\n\nGitHub 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/copilot/cloud-agent/configuration":{"get":{"tags":["Copilot"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot/copilot-cloud-agent-management#get-copilot-cloud-agent-configuration-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/copilot/cloud-agent/configuration"},"summary":"Get Copilot cloud agent configuration for a repository","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the Copilot cloud agent configuration for a repository, including MCP server\nconfiguration, enabled review tools, Actions workflow approval settings, and firewall\nconfiguration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dependabot/alerts":{"get":{"tags":["Dependabot"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"assignee","in":"query","description":"Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"classification","in":"query","description":"A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"ecosystem","in":"query","description":"A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`","schema":{"type":"string","example":""}},{"name":"epss_percentage","in":"query","description":"CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `<n`, `>=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.","schema":{"type":"string","example":""}},{"name":"first","in":"query","description":"**Deprecated**","schema":{"type":"number","example":""}},{"name":"has","in":"query","description":"Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.","schema":{"type":"string","example":""}},{"name":"last","in":"query","description":"**Deprecated**","schema":{"type":"number","example":""}},{"name":"manifest","in":"query","description":"A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.","schema":{"type":"string","example":""}},{"name":"package","in":"query","description":"A comma-separated list of package names. If specified, only alerts for these packages will be returned.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"**Deprecated**","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"relationship","in":"query","description":"A comma-separated list of relationships of the vulnerable dependency to your project. If specified, only alerts with these relationships will be returned.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.","schema":{"type":"string","example":""}},{"name":"scope","in":"query","description":"The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["development","runtime"]}}},{"name":"severity","in":"query","description":"A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","epss_percentage"]}}},{"name":"state","in":"query","description":"A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependabot/alerts"},"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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dependabot/alerts/{alert_number}":{"get":{"tags":["Dependabot"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependabot/alerts/{alert_number}"},"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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Dependabot"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependabot/alerts/{alert_number}"},"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/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).\"\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"agent_assignment":{"type":"object","description":"Parameters for AI agent assignment. Only used when an agent bot login is\nincluded in `assignees`. Ignored when no agent is being assigned.","properties":{"custom_agent":{"type":"string","description":"A custom agent identifier."},"custom_instructions":{"type":"string","description":"Custom instructions for the agent."},"model":{"type":"string","description":"The model to use for the agent."}}},"assignees":{"type":"array","description":"Usernames to assign to this Dependabot Alert.\nPass one or more user logins to _replace_ the set of assignees on this alert.\nSend an empty array (`[]`) to clear all assignees from the alert.\nTo assign an AI agent, include the bot login (for example, `copilot-swe-agent[bot]`).","items":{"type":"string"}},"dismissed_comment":{"type":"string","description":"An optional comment associated with dismissing the alert."},"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"]},"state":{"type":"string","description":"The state of the Dependabot alert.\nA `dismissed_reason` must be provided when setting the state to `dismissed`.","enum":["dismissed","open"]}}},"example":{"agent_assignment":{},"assignees":[],"dismissed_comment":"","dismissed_reason":"","state":""}}}}}},"/repos/{owner}/{repo}/dependabot/secrets":{"get":{"tags":["Dependabot"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#list-repository-secrets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependabot/secrets"},"summary":"List repository secrets","description":"Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dependabot/secrets/public-key":{"get":{"tags":["Dependabot"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependabot/secrets/public-key"},"summary":"Get a repository public key","description":"Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets. Anyone with read access\nto the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dependabot/secrets/{secret_name}":{"get":{"tags":["Dependabot"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependabot/secrets/{secret_name}"},"summary":"Get a repository secret","description":"Gets a single repository secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Dependabot"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependabot/secrets/{secret_name}"},"summary":"Create or update a repository secret","description":"Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/dependabot/secrets#get-a-repository-public-key) endpoint."},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret."}}},"example":{"encrypted_value":"","key_id":""}}}}},"delete":{"tags":["Dependabot"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependabot/secrets/{secret_name}"},"summary":"Delete a repository secret","description":"Deletes a secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/dependency-graph/compare/{basehead}":{"get":{"tags":["Dependency Graph"],"parameters":[{"name":"basehead","in":"path","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}`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"The full path, relative to the repository root, of the dependency manifest file.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependency-graph/compare/{basehead}"},"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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dependency-graph/sbom":{"get":{"tags":["Dependency Graph"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependency-graph/sbom"},"summary":"Export a software bill of materials (SBOM) for a repository.","description":"> [!WARNING]\n> **Closing down notice:** This operation is closing down and will not be accessible after November 13, 2026. Please migrate to the asynchronous flow. Use \"[Request generation of a software bill of materials (SBOM) for a repository](https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository)\" to trigger the report, then \"[Fetch a software bill of materials (SBOM) for a repository](https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository)\" to retrieve it. For more information, see the [changelog](https://github.blog/changelog/2026-05-12-synchronous-sbom-api-deprecated/).\n\nExports the software bill of materials (SBOM) for a repository in SPDX JSON format.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}":{"get":{"tags":["Dependency Graph"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"sbom_uuid","in":"path","description":"The unique identifier of the SBOM export.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependency-graph/sboms#fetch-a-software-bill-of-materials-sbom-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}"},"summary":"Fetch a software bill of materials (SBOM) for a repository.","description":"Fetches a previously generated software bill of materials (SBOM) for a repository.\nWhen the SBOM is ready, the response is a 302 redirect to a temporary download URL for the SBOM in SPDX JSON format.\nThe generated SBOM report may be retained for up to one week from the original request.\nThe temporary download URL returned by this endpoint expires separately, and its expiry is set when the fetch request is made.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dependency-graph/sbom/generate-report":{"get":{"tags":["Dependency Graph"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependency-graph/sboms#request-generation-of-a-software-bill-of-materials-sbom-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependency-graph/sbom/generate-report"},"summary":"Request generation of a software bill of materials (SBOM) for a repository.","description":"Triggers a job to generate a software bill of materials (SBOM) for a repository in SPDX JSON format.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dependency-graph/snapshots":{"post":{"tags":["Dependency Graph"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dependency-graph/snapshots"},"summary":"Create a snapshot of dependencies for a repository","description":"Create a new snapshot of a repository's dependencies.\n\nThe authenticated user must have access to the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"detector":{"type":"object","description":"A description of the detector used.","required":true,"properties":{"name":{"type":"string","description":"The name of the detector used.","required":true},"url":{"type":"string","description":"The url of the detector used.","required":true},"version":{"type":"string","description":"The version of the detector used.","required":true}}},"job":{"type":"object","description":"job","required":true,"properties":{"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.","required":true},"html_url":{"type":"string","description":"The url for the job."},"id":{"type":"string","description":"The external ID of the job.","required":true}}},"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.","properties":{}},"metadata":{"type":"object","description":"User-defined metadata to store domain-specific information limited to 8 keys with scalar values.","properties":{}},"ref":{"type":"string","description":"The repository branch that triggered this snapshot.","required":true},"scanned":{"type":"string","description":"The time at which the snapshot was scanned.","required":true},"sha":{"type":"string","description":"The commit SHA associated with this dependency snapshot. Maximum length: 64 characters.","required":true},"version":{"type":"number","description":"The version of the repository snapshot submission.","required":true}}},"example":{"detector":{},"job":{},"manifests":{},"metadata":{},"ref":"","scanned":"","sha":"","version":""}}}}}},"/repos/{owner}/{repo}/deployments":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"environment","in":"query","description":"The name of the environment that was deployed to (e.g., `staging` or `production`).","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"ref","in":"query","description":"The name of the ref. This can be a branch, tag, or SHA.","schema":{"type":"string","example":""}},{"name":"sha","in":"query","description":"The SHA recorded at creation time.","schema":{"type":"string","example":""}},{"name":"task","in":"query","description":"The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/deployments#list-deployments","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/deployments"},"summary":"List deployments","description":"Simple filtering of deployments is available via query parameters:","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/deployments#create-a-deployment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/deployments"},"summary":"Create a deployment","description":"Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n*   Auto-merge option is enabled in the repository\n*   Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n*   There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"auto_merge":{"type":"boolean","description":"Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.","enum":[true,false]},"description":{"type":"string","description":"Short description of the deployment."},"environment":{"type":"string","description":"Name for the target deployment environment (e.g., `production`, `staging`, `qa`)."},"payload":{"type":"object","description":"payload","properties":{}},"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.","enum":[true,false]},"ref":{"type":"string","description":"The ref to deploy. This can be a branch, tag, or SHA.","required":true},"required_contexts":{"type":"array","description":"The [status](https://docs.github.com/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"}},"task":{"type":"string","description":"Specifies a task to execute (e.g., `deploy` or `deploy:migrations`)."},"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`","enum":[true,false]}}},"example":{"auto_merge":"","description":"","environment":"","payload":{},"production_environment":"","ref":"","required_contexts":[],"task":"","transient_environment":""}}}}}},"/repos/{owner}/{repo}/deployments/{deployment_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"deployment_id","in":"path","description":"deployment_id parameter","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/deployments#get-a-deployment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/deployments/{deployment_id}"},"summary":"Get a deployment","description":"Get a deployment","security":[{"bearerAuth":[]}]},"delete":{"tags":["Repos"],"parameters":[{"name":"deployment_id","in":"path","description":"deployment_id parameter","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/deployments#delete-a-deployment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/deployments/{deployment_id}"},"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.\n\nTo set a deployment as inactive, you must:\n\n*   Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n*   Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses":{"get":{"tags":["Repos"],"parameters":[{"name":"deployment_id","in":"path","description":"deployment_id parameter","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/statuses#list-deployment-statuses","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/deployments/{deployment_id}/statuses"},"summary":"List deployment statuses","description":"Users with pull access can view deployment statuses for a deployment:","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"deployment_id","in":"path","description":"deployment_id parameter","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/statuses#create-a-deployment-status","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/deployments/{deployment_id}/statuses"},"summary":"Create a deployment status","description":"Users with `push` access can create deployment statuses for a given deployment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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`","enum":[true,false]},"description":{"type":"string","description":"A short description of the status. The maximum description length is 140 characters."},"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: `\"\"`"},"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: `\"\"`"},"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.","required":true,"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.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`."}}},"example":{"auto_inactive":"","description":"","environment":"","environment_url":"","log_url":"","state":"","target_url":""}}}}}},"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"deployment_id","in":"path","description":"deployment_id parameter","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"status_id","in":"path","description":"status_id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/statuses#get-a-deployment-status","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"},"summary":"Get a deployment status","description":"Users with pull access can view a deployment status for a deployment:","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/dispatches":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/dispatches"},"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 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/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `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.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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.","properties":{}},"event_type":{"type":"string","description":"A custom webhook event name. Must be 100 characters or fewer.","required":true}}},"example":{"client_payload":{},"event_type":""}}}}}},"/repos/{owner}/{repo}/environments":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/environments#list-environments","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments"},"summary":"List environments","description":"Lists the environments for a repository.\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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/environments/{environment_name}":{"get":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/environments#get-an-environment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}"},"summary":"Get an environment","description":"> [!NOTE]\n> 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).\"\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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/environments#create-or-update-an-environment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}"},"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).\"\n\n> [!NOTE]\n> 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).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deployment_branch_policy":{"type":"object","description":"The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.","properties":{"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`.","required":true,"enum":[true,false]},"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`.","required":true,"enum":[true,false]}}},"prevent_self_review":{"type":"boolean","description":"Whether or not a user who created the job is prevented from approving their own job.","enum":[true,false]},"reviewers":{"type":"array","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":{"type":"string","description":"The type of reviewer.","enum":["User","Team"]},"id":{"type":"number","description":"The id of the user or team who can review the deployment"}}}},"wait_timer":{"type":"number","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)."}}},"example":{"deployment_branch_policy":{},"prevent_self_review":"","reviewers":[],"wait_timer":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/environments#delete-an-environment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}"},"summary":"Delete an environment","description":"OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies":{"get":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies"},"summary":"List deployment branch policies","description":"Lists the deployment branch policies for an environment.\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.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies"},"summary":"Create a deployment branch policy","description":"Creates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"Whether this rule targets a branch or tag","enum":["branch","tag"]},"name":{"type":"string","description":"The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor 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).","required":true}}},"example":{"type":"","name":""}}}}}},"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"branch_policy_id","in":"path","description":"The unique identifier of the branch policy.","required":true,"schema":{"type":"number","example":""}},{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}"},"summary":"Get a deployment branch policy","description":"Gets a deployment branch or tag policy for an environment.\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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"branch_policy_id","in":"path","description":"The unique identifier of the branch policy.","required":true,"schema":{"type":"number","example":""}},{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}"},"summary":"Update a deployment branch policy","description":"Updates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor 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).","required":true}}},"example":{"name":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"branch_policy_id","in":"path","description":"The unique identifier of the branch policy.","required":true,"schema":{"type":"number","example":""}},{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}"},"summary":"Delete a deployment branch policy","description":"Deletes a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules":{"get":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules"},"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/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor 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/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules"},"summary":"Create a custom deployment protection rule on an environment","description":"Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor 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/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"integration_id":{"type":"number","description":"The ID of the custom app that will be enabled on the environment."}}},"example":{"integration_id":""}}}}}},"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps":{"get":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps"},"summary":"List custom deployment rule integrations available for an environment","description":"Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"protection_rule_id","in":"path","description":"The unique identifier of the protection rule.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}"},"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/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Repos"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"protection_rule_id","in":"path","description":"The unique identifier of the protection rule.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}"},"summary":"Disable a custom protection rule for an environment","description":"Disables a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/environments/{environment_name}/secrets":{"get":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#list-environment-secrets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/secrets"},"summary":"List environment secrets","description":"Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key":{"get":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#get-an-environment-public-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key"},"summary":"Get an environment public key","description":"Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}":{"get":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#get-an-environment-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"},"summary":"Get an environment secret","description":"Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"},"summary":"Create or update an environment secret","description":"Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/actions/secrets#get-an-environment-public-key) endpoint.","required":true},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret.","required":true}}},"example":{"encrypted_value":"","key_id":""}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/secrets#delete-an-environment-secret","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}"},"summary":"Delete an environment secret","description":"Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/environments/{environment_name}/variables":{"get":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#list-environment-variables","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/variables"},"summary":"List environment variables","description":"Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#create-an-environment-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/variables"},"summary":"Create an environment variable","description":"Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable.","required":true},"value":{"type":"string","description":"The value of the variable.","required":true}}},"example":{"name":"","value":""}}}}}},"/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}":{"get":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#get-an-environment-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"},"summary":"Get an environment variable","description":"Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#update-an-environment-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"},"summary":"Update an environment variable","description":"Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the variable."},"value":{"type":"string","description":"The value of the variable."}}},"example":{"name":"","value":""}}}}},"delete":{"tags":["Actions"],"parameters":[{"name":"environment_name","in":"path","description":"The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"The name of the variable.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/actions/variables#delete-an-environment-variable","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}"},"summary":"Delete an environment variable","description":"Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/events":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-repository-events","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/events"},"summary":"List repository events","description":"> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/forks":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The sort order. `stargazers` will sort by star count.","schema":{"type":"string","example":"","items":{"type":"string","enum":["newest","oldest","stargazers","watchers"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/forks#list-forks","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/forks"},"summary":"List forks","description":"List forks","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/forks#create-a-fork","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/forks"},"summary":"Create a fork","description":"Create a fork for the authenticated user.\n\n> [!NOTE]\n> 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 Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"default_branch_only":{"type":"boolean","description":"When forking from an existing repository, fork with only the default branch.","enum":[true,false]},"name":{"type":"string","description":"When forking from an existing repository, a new name for the fork."},"organization":{"type":"string","description":"Optional parameter to specify the organization name if forking into an organization."}}},"example":{"default_branch_only":"","name":"","organization":""}}}}}},"/repos/{owner}/{repo}/git/blobs":{"post":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/blobs#create-a-blob","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/blobs"},"summary":"Create a blob","description":"Create a blob","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"The new blob's content.","required":true},"encoding":{"type":"string","description":"The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported."}}},"example":{"content":"","encoding":""}}}}}},"/repos/{owner}/{repo}/git/blobs/{file_sha}":{"get":{"tags":["Git"],"parameters":[{"name":"file_sha","in":"path","description":"file_sha","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/blobs#get-a-blob","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/blobs/{file_sha}"},"summary":"Get a blob","description":"The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`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.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/git/commits":{"post":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/commits#create-a-commit","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/commits"},"summary":"Create a commit","description":"Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe 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:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":{"date":{"type":"string","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`."},"email":{"type":"string","description":"The email of the author (or committer) of the commit","required":true},"name":{"type":"string","description":"The name of the author (or committer) of the commit","required":true}}},"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":{"date":{"type":"string","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`."},"email":{"type":"string","description":"The email of the author (or committer) of the commit"},"name":{"type":"string","description":"The name of the author (or committer) of the commit"}}},"message":{"type":"string","description":"The commit message","required":true},"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"}},"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."},"tree":{"type":"string","description":"The SHA of the tree object this commit points to","required":true}}},"example":{"author":{},"committer":{},"message":"","parents":[],"signature":"","tree":""}}}}}},"/repos/{owner}/{repo}/git/commits/{commit_sha}":{"get":{"tags":["Git"],"parameters":[{"name":"commit_sha","in":"path","description":"The SHA of the commit.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/commits#get-a-commit-object","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/commits/{commit_sha}"},"summary":"Get a commit object","description":"Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe 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:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/git/matching-refs/{ref}":{"get":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/refs#list-matching-references","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/matching-refs/{ref}"},"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/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen 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`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/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/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf 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`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/git/ref/{ref}":{"get":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/refs#get-a-reference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/ref/{ref}"},"summary":"Get a reference","description":"Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/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/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/git/refs":{"post":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/refs#create-a-reference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/refs"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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.","required":true},"sha":{"type":"string","description":"The SHA1 value for this reference.","required":true}}},"example":{"ref":"","sha":""}}}}}},"/repos/{owner}/{repo}/git/refs/{ref}":{"patch":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/refs#update-a-reference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/refs/{ref}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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.","enum":[true,false]},"sha":{"type":"string","description":"The SHA1 value to set this reference to","required":true}}},"example":{"force":"","sha":""}}}}},"delete":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/refs#delete-a-reference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/refs/{ref}"},"summary":"Delete a reference","description":"Deletes the provided reference.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/git/tags":{"post":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/tags#create-a-tag-object","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/tags"},"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/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/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe 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:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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`.","required":true,"enum":["commit","tree","blob"]},"message":{"type":"string","description":"The tag message.","required":true},"object":{"type":"string","description":"The SHA of the git object this is tagging.","required":true},"tag":{"type":"string","description":"The tag's name. This is typically a version (e.g., \"v0.0.1\").","required":true},"tagger":{"type":"object","description":"An object with information about the individual creating the tag.","properties":{"date":{"type":"string","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`."},"email":{"type":"string","description":"The email of the author of the tag","required":true},"name":{"type":"string","description":"The name of the author of the tag","required":true}}}}},"example":{"type":"","message":"","object":"","tag":"","tagger":{}}}}}}},"/repos/{owner}/{repo}/git/tags/{tag_sha}":{"get":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"tag_sha","in":"path","description":"tag_sha","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/tags#get-a-tag","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/tags/{tag_sha}"},"summary":"Get a tag","description":"**Signature verification object**\n\nThe 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:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/git/trees":{"post":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/trees#create-a-tree","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/trees"},"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.\n\nIf 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/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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.\nIf 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."},"tree":{"type":"array","description":"Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.","required":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"Either `blob`, `tree`, or `commit`.","enum":["blob","tree","commit"]},"path":{"type":"string","description":"The file referenced in the tree."},"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."},"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"]},"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."}}}}}},"example":{"base_tree":"","tree":[]}}}}}},"/repos/{owner}/{repo}/git/trees/{tree_sha}":{"get":{"tags":["Git"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"tree_sha","in":"path","description":"The SHA1 value or ref (branch or tag) name of the tree.","required":true,"schema":{"type":"string","example":""}},{"name":"recursive","in":"query","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.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/git/trees#get-a-tree","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/git/trees/{tree_sha}"},"summary":"Get a tree","description":"Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `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.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/hash-algorithm":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#get-the-hash-algorithm-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hash-algorithm"},"summary":"Get the hash algorithm for a repository","description":"Returns the hash algorithm used to store repository objects.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/hooks":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#list-repository-webhooks","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks"},"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.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks"},"summary":"Create a repository webhook","description":"Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","enum":[true,false]},"config":{"type":"object","description":"Key/value pairs to provide settings for this webhook.","properties":{"content_type":{"type":"string","description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."},"insecure_ssl":{"type":"string","description":"insecure_ssl"},"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/webhooks/event-payloads/#delivery-headers)."},"url":{"type":"string","description":"The URL to which the payloads will be delivered."}}},"events":{"type":"array","description":"Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.","items":{"type":"string"}},"name":{"type":"string","description":"Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`."}}},"example":{"active":"","config":{},"events":[],"name":""}}}}}},"/repos/{owner}/{repo}/hooks/{hook_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}"},"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).\"","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}"},"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).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.","enum":[true,false]},"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"}},"config":{"type":"object","description":"Configuration object of the webhook","properties":{"content_type":{"type":"string","description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."},"insecure_ssl":{"type":"string","description":"insecure_ssl"},"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/webhooks/event-payloads/#delivery-headers)."},"url":{"type":"string","description":"The URL to which the payloads will be delivered."}}},"events":{"type":"array","description":"Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.","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"}}}},"example":{"active":"","add_events":[],"config":{},"events":[],"remove_events":[]}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}"},"summary":"Delete a repository webhook","description":"Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/hooks/{hook_id}/config":{"get":{"tags":["Repos"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}/config"},"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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}/config"},"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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content_type":{"type":"string","description":"The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."},"insecure_ssl":{"type":"string","description":"insecure_ssl"},"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/webhooks/event-payloads/#delivery-headers)."},"url":{"type":"string","description":"The URL to which the payloads will be delivered."}}},"example":{"content_type":"","insecure_ssl":"","secret":"","url":""}}}}}},"/repos/{owner}/{repo}/hooks/{hook_id}/deliveries":{"get":{"tags":["Repos"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"redelivery","in":"query","description":"redelivery","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"status","in":"query","description":"Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).","schema":{"type":"string","example":"","items":{"type":"string","enum":["success","failure"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}/deliveries"},"summary":"List deliveries for a repository webhook","description":"Returns a list of webhook deliveries for a webhook configured in a repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"delivery_id","in":"path","description":"delivery_id","required":true,"schema":{"type":"number","example":""}},{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}"},"summary":"Get a delivery for a repository webhook","description":"Returns a delivery for a webhook configured in a repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts":{"post":{"tags":["Repos"],"parameters":[{"name":"delivery_id","in":"path","description":"delivery_id","required":true,"schema":{"type":"number","example":""}},{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts"},"summary":"Redeliver a delivery for a repository webhook","description":"Redeliver a webhook delivery for a webhook configured in a repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/hooks/{hook_id}/pings":{"post":{"tags":["Repos"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}/pings"},"summary":"Ping a repository webhook","description":"This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/hooks/{hook_id}/tests":{"post":{"tags":["Repos"],"parameters":[{"name":"hook_id","in":"path","description":"The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/hooks/{hook_id}/tests"},"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.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/immutable-releases":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/immutable-releases"},"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\nenforced by the repository owner.  The authenticated user must have admin read access to the repository.","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#enable-immutable-releases","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/immutable-releases"},"summary":"Enable immutable releases","description":"Enables immutable releases for a repository. The authenticated user must have admin access to the repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#disable-immutable-releases","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/immutable-releases"},"summary":"Disable immutable releases","description":"Disables immutable releases for a repository. The authenticated user must have admin access to the repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/import":{"get":{"tags":["Migrations"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/source-imports#get-an-import-status","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/import"},"summary":"Get an import status","description":"View the progress of an import.\n\n> [!WARNING]\n> **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).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n*   `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.\n*   `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).\n*   `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.\n*   `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n*   `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n*   `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/rest/migrations/source-imports#update-an-import) section.\n*   `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n*   `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/rest/migrations/source-imports#update-an-import) section.\n*   `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n*   `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/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen 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.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n*   `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.\n*   `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n*   `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n*   `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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Migrations"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/source-imports#start-an-import","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/import"},"summary":"Start an import","description":"Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n> [!WARNING]\n> **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).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tfvc_project":{"type":"string","description":"For a tfvc import, the name of the project that is being imported."},"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_password":{"type":"string","description":"If authentication is required, the password to provide to `vcs_url`."},"vcs_url":{"type":"string","description":"The URL of the originating repository.","required":true},"vcs_username":{"type":"string","description":"If authentication is required, the username to provide to `vcs_url`."}}},"example":{"tfvc_project":"","vcs":"","vcs_password":"","vcs_url":"","vcs_username":""}}}}},"patch":{"tags":["Migrations"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/source-imports#update-an-import","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/import"},"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\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n> [!WARNING]\n> **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).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tfvc_project":{"type":"string","description":"For a tfvc import, the name of the project that is being imported."},"vcs":{"type":"string","description":"The type of version control system you are migrating from.","enum":["subversion","tfvc","git","mercurial"]},"vcs_password":{"type":"string","description":"The password to provide to the originating repository."},"vcs_username":{"type":"string","description":"The username to provide to the originating repository."}}},"example":{"tfvc_project":"","vcs":"","vcs_password":"","vcs_username":""}}}}},"delete":{"tags":["Migrations"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/source-imports#cancel-an-import","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/import"},"summary":"Cancel an import","description":"Stop an import for a repository.\n\n> [!WARNING]\n> **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).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/import/authors":{"get":{"tags":["Migrations"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"since","in":"query","description":"A user ID. Only return users with an ID greater than this ID.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/source-imports#get-commit-authors","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/import/authors"},"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 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 <hubot@12341234-abab-fefe-8787-fedcba987654>`.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **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).","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/import/authors/{author_id}":{"patch":{"tags":["Migrations"],"parameters":[{"name":"author_id","in":"path","description":"author_id","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/source-imports#map-a-commit-author","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/import/authors/{author_id}"},"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\nnew commits to the repository.\n\n> [!WARNING]\n> **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).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The new Git author email."},"name":{"type":"string","description":"The new Git author name."}}},"example":{"email":"","name":""}}}}}},"/repos/{owner}/{repo}/import/large_files":{"get":{"tags":["Migrations"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/source-imports#get-large-files","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/import/large_files"},"summary":"Get large files","description":"List files larger than 100MB found during the import\n\n> [!WARNING]\n> **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).","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/import/lfs":{"patch":{"tags":["Migrations"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/import/lfs"},"summary":"Update Git LFS preference","description":"You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **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).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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.","required":true,"enum":["opt_in","opt_out"]}}},"example":{"use_lfs":""}}}}}},"/repos/{owner}/{repo}/installation":{"get":{"tags":["Apps"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/installation"},"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.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/interaction-limits":{"get":{"tags":["Interactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/interaction-limits"},"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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Interactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/interaction-limits"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"expiry":{"type":"string","description":"The duration of the interaction restriction. Default: `one_day`.","enum":["one_day","three_days","one_week","one_month","six_months"]},"limit":{"type":"string","description":"The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.","required":true,"enum":["existing_users","contributors_only","collaborators_only"]}}},"example":{"expiry":"","limit":""}}}}},"delete":{"tags":["Interactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/interaction-limits"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/interaction-limits/pulls/bypass-list":{"get":{"tags":["Interactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-bypass-list-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/interaction-limits/pulls/bypass-list"},"summary":"Get pull request creation cap bypass list for a repository","description":"Lists the users that are on the pull request creation cap bypass list for a\nrepository. Users on this list can create pull requests regardless of any\nconfigured pull request creation cap.\n\nOnly users with maintainer permissions can view the bypass list.","security":[{"bearerAuth":[]}]},"put":{"tags":["Interactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/repos#add-users-to-the-pull-request-creation-cap-bypass-list-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/interaction-limits/pulls/bypass-list"},"summary":"Add users to the pull request creation cap bypass list for a repository","description":"Adds users to the pull request creation cap bypass list for a repository.\nUsers on this list can create pull requests regardless of any configured\npull request creation cap.\n\nOnly users with maintainer permissions can modify the bypass list.\nYou can add a maximum of 100 users per request.\nThe bypass list can only hold a maximum of 100 users.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"users":{"type":"array","description":"A list of user logins to add or remove from the bypass list.","required":true,"items":{"type":"string"}}}},"example":{"users":[]}}}}},"delete":{"tags":["Interactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/repos#remove-users-from-the-pull-request-creation-cap-bypass-list-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/interaction-limits/pulls/bypass-list"},"summary":"Remove users from the pull request creation cap bypass list for a repository","description":"Removes users from the pull request creation cap bypass list for a repository.\nRemoved users will be subject to any configured pull request creation cap.\n\nOnly users with maintainer permissions can modify the bypass list.\nYou can remove a maximum of 100 users per request.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"users":{"type":"array","description":"A list of user logins to add or remove from the bypass list.","required":true,"items":{"type":"string"}}}},"example":{"users":[]}}}}}},"/repos/{owner}/{repo}/interaction-limits/pulls/creation-cap":{"get":{"tags":["Interactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/interaction-limits/pulls/creation-cap"},"summary":"Get pull request creation cap for a repository","description":"Gets the pull request creation cap configuration for a repository.\nThe cap limits the number of open pull requests a user can have at one time.\n\nOnly users with admin access to the repository can view the cap configuration.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Interactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/repos#update-pull-request-creation-cap-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/interaction-limits/pulls/creation-cap"},"summary":"Update pull request creation cap for a repository","description":"Updates the pull request creation cap for a repository. The cap limits the number\nof open pull requests a user can have at one time.\n\nOnly users with admin access to the repository can configure the cap.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enabled":{"type":"boolean","description":"Whether the pull request creation cap is enabled","required":true,"enum":[true,false]},"max_open_pull_requests":{"type":"number","description":"The maximum number of open pull requests a user can have at one time"}}},"example":{"enabled":"","max_open_pull_requests":""}}}}}},"/repos/{owner}/{repo}/invitations":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/invitations#list-repository-invitations","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/invitations"},"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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/invitations/{invitation_id}":{"patch":{"tags":["Repos"],"parameters":[{"name":"invitation_id","in":"path","description":"The unique identifier of the invitation.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/invitations/{invitation_id}"},"summary":"Update a repository invitation","description":"Update a repository invitation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"]}}},"example":{"permissions":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"invitation_id","in":"path","description":"The unique identifier of the invitation.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/invitations/{invitation_id}"},"summary":"Delete a repository invitation","description":"Delete a repository invitation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issue-types":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/issue-types#list-issue-types-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issue-types"},"summary":"List issue types for a repository","description":"Lists issue types available for a repository (inherited from its organization owner, with any per-repository overrides applied).\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.\nFine-grained access tokens require the \"Metadata\" repository permission (read).","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues":{"get":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","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.","schema":{"type":"string","example":""}},{"name":"assignee","in":"query","description":"Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.","schema":{"type":"string","example":""}},{"name":"creator","in":"query","description":"The user that created the issue.","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"issue_field_values","in":"query","description":"A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.","schema":{"type":"string","example":""}},{"name":"labels","in":"query","description":"A list of comma separated label names. Example: `bug,ui,@high`","schema":{"type":"string","example":""}},{"name":"mentioned","in":"query","description":"A user that's mentioned in the issue.","schema":{"type":"string","example":""}},{"name":"milestone","in":"query","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.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"What to sort results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","comments"]}}},{"name":"state","in":"query","description":"Indicates the state of the issues to return.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#list-repository-issues","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues"},"summary":"List repository issues","description":"List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> 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/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#create-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues"},"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/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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._"},"body":{"type":"string","description":"The contents of the issue."},"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"}},"issue_field_values":{"type":"array","description":"An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.","items":{"type":"object","properties":{"field_id":{"type":"number","description":"The ID of the issue field to set","required":true},"value":{"type":"string","description":"The value to set for the field. For multi-select fields, provide an array of option names.","required":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":{"type":"string"}},"milestone":{"type":"string","description":"milestone"},"parent_issue_id":{"type":"number","description":"The id of the parent issue to add this issue to as a sub-issue. _NOTE: Only users with triage access to both the parent issue's repository and this repository can set the parent issue._"},"title":{"type":"string","description":"The title of the issue.","required":true}}},"example":{"type":"","body":"","assignees":[],"issue_field_values":[],"labels":[],"milestone":"","parent_issue_id":"","title":""}}}}}},"/repos/{owner}/{repo}/issues/comments":{"get":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"Either `asc` or `desc`. Ignored without the `sort` parameter.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments"},"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.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues/comments/{comment_id}":{"get":{"tags":["Issues"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/comments#get-an-issue-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}"},"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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Issues"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/comments#update-an-issue-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}"},"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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The contents of the comment.","required":true}}},"example":{"body":""}}}}},"delete":{"tags":["Issues"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/comments#delete-an-issue-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/comments/{comment_id}/pin":{"put":{"tags":["Issues"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/comments#pin-an-issue-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}/pin"},"summary":"Pin an issue comment","description":"You can use the REST API to pin comments on issues.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Issues"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/comments#unpin-an-issue-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}/pin"},"summary":"Unpin an issue comment","description":"You can use the REST API to unpin comments on issues.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions":{"get":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"content","in":"query","description":"Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.","schema":{"type":"string","example":"","items":{"type":"string","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"},"summary":"List reactions for an issue comment","description":"List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).","security":[{"bearerAuth":[]}]},"post":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"},"summary":"Create reaction for an issue comment","description":"Create a reaction to an [issue comment](https://docs.github.com/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.","required":true,"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]}}},"example":{"content":""}}}}}},"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}":{"delete":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"reaction_id","in":"path","description":"The unique identifier of the reaction.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}"},"summary":"Delete an issue comment reaction","description":"> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/events":{"get":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/events"},"summary":"List issue events for a repository","description":"Lists events for a repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues/events/{event_id}":{"get":{"tags":["Issues"],"parameters":[{"name":"event_id","in":"path","description":"event_id","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/events#get-an-issue-event","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/events/{event_id}"},"summary":"Get an issue event","description":"Gets a single event by the event id.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues/{issue_number}":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#get-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}"},"summary":"Get an issue","description":"The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> 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/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#update-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}"},"summary":"Update an issue","description":"Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"The issue type to associate with this issue. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped."},"body":{"type":"string","description":"The contents of the issue."},"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"}},"duplicate_issue_id":{"type":"number","description":"The ID of the issue to mark as the canonical duplicate when `state_reason` is `duplicate`. The issue must exist and be accessible to the authenticated user. Ignored when `state_reason` is not `duplicate`."},"issue_field_values":{"type":"array","description":"An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Only users with push access can set field values for issues","items":{"type":"object","properties":{"confidence":{"type":"string","description":"The confidence level for this field value choice.","enum":["low","medium","high"]},"field_id":{"type":"number","description":"The ID of the issue field to set","required":true},"rationale":{"type":"string","description":"Optional reasoning for setting this field value."},"suggest":{"type":"boolean","description":"If `true`, the change is stored as a pending suggestion for human review rather than applied directly.","enum":[true,false]},"value":{"type":"string","description":"The value to set for the field. For multi-select fields, provide an array of option names.","required":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":{"type":"string"}},"milestone":{"type":"string","description":"milestone"},"state":{"type":"string","description":"The open or closed state of the issue.","enum":["open","closed"]},"state_reason":{"type":"string","description":"The reason for the state change. Ignored unless `state` is changed.","enum":["completed","not_planned","duplicate","reopened"]},"title":{"type":"string","description":"The title of the issue."}}},"example":{"type":"","body":"","assignees":[],"duplicate_issue_id":"","issue_field_values":[],"labels":[],"milestone":"","state":"","state_reason":"","title":""}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/assignees":{"post":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/assignees"},"summary":"Add assignees to an issue","description":"Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"}}}},"example":{"assignees":[]}}}}},"delete":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/assignees"},"summary":"Remove assignees from an issue","description":"Removes one or more assignees from an issue.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"}}}},"example":{"assignees":[]}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}":{"get":{"tags":["Issues"],"parameters":[{"name":"assignee","in":"path","description":"assignee","required":true,"schema":{"type":"string","example":""}},{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}"},"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.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues/{issue_number}/comments":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/comments#list-issue-comments","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments"},"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.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/comments#create-an-issue-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments"},"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.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The contents of the comment.","required":true}}},"example":{"body":""}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by"},"summary":"List dependencies an issue is blocked by","description":"You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by"},"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.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"issue_id":{"type":"number","description":"The id of the issue that blocks the current issue","required":true}}},"example":{"issue_id":""}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}":{"delete":{"tags":["Issues"],"parameters":[{"name":"issue_id","in":"path","description":"The id of the blocking issue to remove as a dependency","required":true,"schema":{"type":"number","example":""}},{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}"},"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.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking"},"summary":"List dependencies an issue is blocking","description":"You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues/{issue_number}/events":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/events#list-issue-events","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/events"},"summary":"List issue events","description":"Lists all events for an issue.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values"},"summary":"List issue field values for an issue","description":"Lists all issue field values for an issue.","security":[{"bearerAuth":[]}]},"post":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values"},"summary":"Add issue field values to an issue","description":"Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"issue_field_values":{"type":"array","description":"An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.","items":{"type":"object","properties":{"field_id":{"type":"number","description":"The ID of the issue field to set","required":true},"value":{"type":"string","description":"The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For multi_select fields: provide an array of option names (must match existing options)\n- For date fields: provide an ISO 8601 date string","required":true}}}}}},"example":{"issue_field_values":[]}}}}},"put":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values"},"summary":"Set issue field values for an issue","description":"Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"issue_field_values":{"type":"array","description":"An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.","items":{"type":"object","properties":{"field_id":{"type":"number","description":"The ID of the issue field to set","required":true},"value":{"type":"string","description":"The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string","required":true}}}}}},"example":{"issue_field_values":[]}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}":{"delete":{"tags":["Issues"],"parameters":[{"name":"issue_field_id","in":"path","description":"The unique identifier of the issue field.","required":true,"schema":{"type":"number","example":""}},{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}"},"summary":"Delete an issue field value from an issue","description":"Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/labels":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#list-labels-for-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/labels"},"summary":"List labels for an issue","description":"Lists all labels for an issue.","security":[{"bearerAuth":[]}]},"post":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#add-labels-to-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/labels"},"summary":"Add labels to an issue","description":"Adds labels to an issue.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"The labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"","items":{"type":"string"}}}},"example":{"labels":[]}}}}},"put":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#set-labels-for-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/labels"},"summary":"Set labels for an issue","description":"Removes any previous labels and sets the new labels for an issue.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","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/rest/issues/labels#add-labels-to-an-issue).\"","items":{"type":"string"}}}},"example":{"labels":[]}}}}},"delete":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/labels"},"summary":"Remove all labels from an issue","description":"Removes all labels from an issue.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}":{"delete":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/lock":{"put":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#lock-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/lock"},"summary":"Lock an issue","description":"Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"]}}},"example":{"lock_reason":""}}}}},"delete":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#unlock-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/lock"},"summary":"Unlock an issue","description":"Users with push access can unlock an issue's conversation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/parent":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/sub-issues#get-parent-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/parent"},"summary":"Get parent issue","description":"You can use the REST API to get the parent issue of a sub-issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues/{issue_number}/reactions":{"get":{"tags":["Reactions"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"content","in":"query","description":"Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.","schema":{"type":"string","example":"","items":{"type":"string","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/reactions"},"summary":"List reactions for an issue","description":"List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).","security":[{"bearerAuth":[]}]},"post":{"tags":["Reactions"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/reactions"},"summary":"Create reaction for an issue","description":"Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue.","required":true,"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]}}},"example":{"content":""}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}":{"delete":{"tags":["Reactions"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"reaction_id","in":"path","description":"The unique identifier of the reaction.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}"},"summary":"Delete an issue reaction","description":"> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/sub_issue":{"delete":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/sub-issues#remove-sub-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/sub_issue"},"summary":"Remove sub-issue","description":"You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sub_issue_id":{"type":"number","description":"The id of the sub-issue to remove","required":true}}},"example":{"sub_issue_id":""}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/sub_issues":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/sub-issues#list-sub-issues","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/sub_issues"},"summary":"List sub-issues","description":"You can use the REST API to list the sub-issues on an issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/sub-issues#add-sub-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/sub_issues"},"summary":"Add sub-issue","description":"You can use the REST API to add sub-issues to issues.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"replace_parent":{"type":"boolean","description":"Option that, when true, instructs the operation to replace the sub-issues current parent issue","enum":[true,false]},"sub_issue_id":{"type":"number","description":"The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue","required":true}}},"example":{"replace_parent":"","sub_issue_id":""}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority":{"patch":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority"},"summary":"Reprioritize sub-issue","description":"You can use the REST API to reprioritize a sub-issue to a different position in the parent list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"after_id":{"type":"number","description":"The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified)."},"before_id":{"type":"number","description":"The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified)."},"sub_issue_id":{"type":"number","description":"The id of the sub-issue to reprioritize","required":true}}},"example":{"after_id":"","before_id":"","sub_issue_id":""}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/suggestions":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"action","in":"query","description":"Filter suggestions by the change they propose.","schema":{"type":"string","example":"","items":{"type":"string","enum":["set_type","add_label","add_field","add_assignee","close_issue"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"state","in":"query","description":"Filter suggestions by their state.","schema":{"type":"string","example":"","items":{"type":"string","enum":["pending","applied","approved","dismissed","replaced","invalidated","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#list-issue-suggestions","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/suggestions"},"summary":"List issue suggestions","description":"Lists the suggestions on an issue. A suggestion is an agent-proposed change to an issue's type, labels, fields, assignees, or closed state that a maintainer can approve or dismiss.\n\nBy default only pending suggestions are returned. Use `state=all` to return suggestions in every state, or `state=<state>` to filter to a single state. Use `action=<action>` to return only suggestions for a specific change.\n\nThis endpoint is only available while the issue suggestions feature is enabled for the repository, and only supports issues, not pull requests.\n\nRequires triage access to the repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/issues/{issue_number}/suggestions/{suggestion_id}/approve":{"post":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"suggestion_id","in":"path","description":"The unique identifier of the suggestion.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#approve-an-issue-suggestion","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/suggestions/{suggestion_id}/approve"},"summary":"Approve an issue suggestion","description":"Approves a pending suggestion on an issue. Applies the proposed change (creating the corresponding timeline event), transitions the suggestion to `approved`, and dismisses any competing pending suggestions for the same change.\n\nRequires triage access to the repository. Approving a suggestion also requires permission to perform the change it applies (for example, setting the issue type, adding a label or assignee, or closing the issue); this only affects fine-grained access tokens and GitHub Apps whose permissions are narrower than the triage role. This endpoint only supports issues, not pull requests.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/suggestions/{suggestion_id}/dismiss":{"post":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"suggestion_id","in":"path","description":"The unique identifier of the suggestion.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#dismiss-an-issue-suggestion","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/suggestions/{suggestion_id}/dismiss"},"summary":"Dismiss an issue suggestion","description":"Dismisses a pending suggestion on an issue. Transitions the suggestion to `dismissed` without applying any change or creating a timeline event.\n\nRequires triage access to the repository. This endpoint only supports issues, not pull requests.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/issues/{issue_number}/timeline":{"get":{"tags":["Issues"],"parameters":[{"name":"issue_number","in":"path","description":"The number that identifies the issue.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"exclude","in":"query","description":"A comma-separated list of timeline event names to exclude from the response.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/timeline"},"summary":"List timeline events for an issue","description":"List all timeline events for an issue.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/keys":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/keys"},"summary":"List deploy keys","description":"List deploy keys","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/keys"},"summary":"Create a deploy key","description":"You can create a read-only deploy key.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key":{"type":"string","description":"The contents of the key.","required":true},"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/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"","enum":[true,false]},"title":{"type":"string","description":"A name for the key."}}},"example":{"key":"","read_only":"","title":""}}}}}},"/repos/{owner}/{repo}/keys/{key_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"key_id","in":"path","description":"The unique identifier of the key.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/keys/{key_id}"},"summary":"Get a deploy key","description":"Get a deploy key","security":[{"bearerAuth":[]}]},"delete":{"tags":["Repos"],"parameters":[{"name":"key_id","in":"path","description":"The unique identifier of the key.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/keys/{key_id}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/labels":{"get":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#list-labels-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/labels"},"summary":"List labels for a repository","description":"Lists all labels for a repository.","security":[{"bearerAuth":[]}]},"post":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#create-a-label","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/labels"},"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/).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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."},"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).\"","required":true}}},"example":{"color":"","description":"","name":""}}}}}},"/repos/{owner}/{repo}/labels/{name}":{"get":{"tags":["Issues"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#get-a-label","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/labels/{name}"},"summary":"Get a label","description":"Gets a label using the given name.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Issues"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#update-a-label","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/labels/{name}"},"summary":"Update a label","description":"Updates a label using the given label name.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archived":{"type":"boolean","description":"Whether to archive or unarchive the label. Archived labels cannot be added to issues or pull requests. For more information, see \"[Archiving labels](https://docs.github.com/issues/organizing-your-work-with-labels/managing-labels).\"","enum":[true,false]},"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."},"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).\""}}},"example":{"archived":"","color":"","description":"","new_name":""}}}}},"delete":{"tags":["Issues"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#delete-a-label","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/labels/{name}"},"summary":"Delete a label","description":"Deletes a label using the given label name.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/languages":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-repository-languages","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/languages"},"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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/license":{"get":{"tags":["Licenses"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"query","description":"The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/license"},"summary":"Get the license for a repository","description":"This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`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).","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/merge-upstream":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/merge-upstream"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"branch":{"type":"string","description":"The name of the branch which should be updated to match upstream.","required":true}}},"example":{"branch":""}}}}}},"/repos/{owner}/{repo}/merges":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/branches/branches#merge-a-branch","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/merges"},"summary":"Merge a branch","description":"Merge a branch","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"base":{"type":"string","description":"The name of the base branch that the head will be merged into.","required":true},"commit_message":{"type":"string","description":"Commit message to use for the merge commit. If omitted, a default message will be used."},"head":{"type":"string","description":"The head to merge. This can be a branch name or a commit SHA1.","required":true}}},"example":{"base":"","commit_message":"","head":""}}}}}},"/repos/{owner}/{repo}/milestones":{"get":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction of the sort. Either `asc` or `desc`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"What to sort results by. Either `due_on` or `completeness`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["due_on","completeness"]}}},{"name":"state","in":"query","description":"The state of the milestone. Either `open`, `closed`, or `all`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/milestones#list-milestones","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/milestones"},"summary":"List milestones","description":"Lists milestones for a repository.","security":[{"bearerAuth":[]}]},"post":{"tags":["Issues"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/milestones#create-a-milestone","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/milestones"},"summary":"Create a milestone","description":"Creates a milestone.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A description of the milestone."},"due_on":{"type":"string","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`."},"state":{"type":"string","description":"The state of the milestone. Either `open` or `closed`.","enum":["open","closed"]},"title":{"type":"string","description":"The title of the milestone.","required":true}}},"example":{"description":"","due_on":"","state":"","title":""}}}}}},"/repos/{owner}/{repo}/milestones/{milestone_number}":{"get":{"tags":["Issues"],"parameters":[{"name":"milestone_number","in":"path","description":"The number that identifies the milestone.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/milestones#get-a-milestone","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/milestones/{milestone_number}"},"summary":"Get a milestone","description":"Gets a milestone using the given milestone number.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Issues"],"parameters":[{"name":"milestone_number","in":"path","description":"The number that identifies the milestone.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/milestones#update-a-milestone","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/milestones/{milestone_number}"},"summary":"Update a milestone","description":"Update a milestone","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A description of the milestone."},"due_on":{"type":"string","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`."},"state":{"type":"string","description":"The state of the milestone. Either `open` or `closed`.","enum":["open","closed"]},"title":{"type":"string","description":"The title of the milestone."}}},"example":{"description":"","due_on":"","state":"","title":""}}}}},"delete":{"tags":["Issues"],"parameters":[{"name":"milestone_number","in":"path","description":"The number that identifies the milestone.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/milestones#delete-a-milestone","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/milestones/{milestone_number}"},"summary":"Delete a milestone","description":"Deletes a milestone using the given milestone number.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/milestones/{milestone_number}/labels":{"get":{"tags":["Issues"],"parameters":[{"name":"milestone_number","in":"path","description":"The number that identifies the milestone.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/milestones/{milestone_number}/labels"},"summary":"List labels for issues in a milestone","description":"Lists labels for issues in a milestone.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/notifications":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"all","in":"query","description":"If `true`, show notifications marked as read.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"before","in":"query","description":"Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"participating","in":"query","description":"If `true`, only shows notifications in which the user is directly participating or mentioned.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/notifications"},"summary":"List repository notifications for the authenticated user","description":"Lists all notifications for the current user in the specified repository.","security":[{"bearerAuth":[]}]},"put":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/notifications"},"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 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/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"last_read_at":{"type":"string","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."}}},"example":{"last_read_at":""}}}}}},"/repos/{owner}/{repo}/pages":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages"},"summary":"Get a GitHub Pages site","description":"Gets information about a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages"},"summary":"Create a GitHub Pages site","description":"Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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":{"path":{"type":"string","description":"The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`","enum":["/","/docs"]},"branch":{"type":"string","description":"The repository branch used to publish your site's source files.","required":true}}}}},"example":{"build_type":"","source":{}}}}}},"put":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages"},"summary":"Update information about a GitHub Pages site","description":"Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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"]},"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/pages/configuring-a-custom-domain-for-your-github-pages-site).\""},"https_enforced":{"type":"boolean","description":"Specify whether HTTPS should be enforced for the repository.","enum":[true,false]},"source":{"type":"string","description":"source"}}},"example":{"build_type":"","cname":"","https_enforced":"","source":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages"},"summary":"Delete a GitHub Pages site","description":"Deletes a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/pages/builds":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#list-apiname-pages-builds","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages/builds"},"summary":"List GitHub Pages builds","description":"Lists builts of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages/builds"},"summary":"Request a GitHub 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.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/pages/builds/latest":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#get-latest-pages-build","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages/builds/latest"},"summary":"Get latest Pages build","description":"Gets information about the single most recent build of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/pages/builds/{build_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"build_id","in":"path","description":"build_id","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#get-apiname-pages-build","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages/builds/{build_id}"},"summary":"Get GitHub Pages build","description":"Gets information about a GitHub Pages build.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/pages/deployments":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages/deployments"},"summary":"Create a GitHub Pages deployment","description":"Create a GitHub Pages deployment for a repository.\n\nThe authenticated user must have write permission to the repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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."},"oidc_token":{"type":"string","description":"The OIDC token issued by GitHub Actions certifying the origin of the deployment.","required":true},"pages_build_version":{"type":"string","description":"A unique string that represents the version of the build for this deployment.","required":true}}},"example":{"artifact_id":"","artifact_url":"","environment":"","oidc_token":"","pages_build_version":""}}}}}},"/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pages_deployment_id","in":"path","description":"The ID of the Pages deployment. You can also give the commit SHA of the deployment.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}"},"summary":"Get the status of a GitHub Pages deployment","description":"Gets the current status of a GitHub Pages deployment.\n\nThe authenticated user must have read permission for the GitHub Pages site.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pages_deployment_id","in":"path","description":"The ID of the Pages deployment. You can also give the commit SHA of the deployment.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel"},"summary":"Cancel a GitHub Pages deployment","description":"Cancels a GitHub Pages deployment.\n\nThe authenticated user must have write permissions for the GitHub Pages site.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/pages/health":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pages/health"},"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.\n\nThe 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.\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/private-vulnerability-reporting":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/private-vulnerability-reporting"},"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/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/private-vulnerability-reporting"},"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/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/private-vulnerability-reporting"},"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/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/properties/values":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/properties/values"},"summary":"Get all custom property values for a repository","description":"Gets all custom property values that are set for a repository.\nUsers with read access to the repository can use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/properties/values"},"summary":"Create or update custom property values for a repository","description":"Create new or update existing custom property values for a repository.\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"array","description":"A list of custom property names and associated values to apply to the repositories.","required":true,"items":{"type":"object","properties":{"property_name":{"type":"string","description":"The name of the property","required":true},"value":{"type":"string","description":"The value assigned to the property","required":true}}}}}},"example":{"properties":[]}}}}}},"/repos/{owner}/{repo}/pulls":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"base","in":"query","description":"Filter pulls by base branch name. Example: `gh-pages`.","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"head","in":"query","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`.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","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.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","popularity","long-running"]}}},{"name":"state","in":"query","description":"Either `open`, `closed`, or `all` to filter by state.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#list-pull-requests","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls"},"summary":"List pull requests","description":"Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#create-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/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/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The contents of the pull request."},"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.","required":true},"draft":{"type":"boolean","description":"Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.","enum":[true,false]},"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`.","required":true},"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."},"issue":{"type":"number","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."},"maintainer_can_modify":{"type":"boolean","description":"Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.","enum":[true,false]},"title":{"type":"string","description":"The title of the new pull request. Required unless `issue` is specified."}}},"example":{"body":"","base":"","draft":"","head":"","head_repo":"","issue":"","maintainer_can_modify":"","title":""}}}}}},"/repos/{owner}/{repo}/pulls/comments":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort results. Ignored without `sort` parameter.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"sort","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","created_at"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/comments"},"summary":"List review comments in a repository","description":"Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/pulls/comments/{comment_id}":{"get":{"tags":["Pulls"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/comments/{comment_id}"},"summary":"Get a review comment for a pull request","description":"Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Pulls"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/comments/{comment_id}"},"summary":"Update a review comment for a pull request","description":"Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The text of the reply to the review comment.","required":true}}},"example":{"body":""}}}}},"delete":{"tags":["Pulls"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/comments/{comment_id}"},"summary":"Delete a review comment for a pull request","description":"Deletes a review comment.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions":{"get":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"content","in":"query","description":"Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.","schema":{"type":"string","example":"","items":{"type":"string","enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"},"summary":"List reactions for a pull request review comment","description":"List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).","security":[{"bearerAuth":[]}]},"post":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"},"summary":"Create reaction for a pull request review comment","description":"Create a reaction to a [pull request review comment](https://docs.github.com/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment.","required":true,"enum":["+1","-1","laugh","confused","heart","hooray","rocket","eyes"]}}},"example":{"content":""}}}}}},"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}":{"delete":{"tags":["Reactions"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"reaction_id","in":"path","description":"The unique identifier of the reaction.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}"},"summary":"Delete a pull request comment reaction","description":"> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#get-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub 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/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub 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.\n\nThe 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:\n\n*   If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n*   If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n*   If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#update-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}"},"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/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The contents of the pull request."},"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/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.","enum":[true,false]},"state":{"type":"string","description":"State of this Pull Request. Either `open` or `closed`.","enum":["open","closed"]},"title":{"type":"string","description":"The title of the pull request."}}},"example":{"body":"","base":"","maintainer_can_modify":"","state":"","title":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":{"post":{"tags":["Codespaces"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/codespaces"},"summary":"Create a codespace from a pull request","description":"Creates a codespace owned by the authenticated user for the specified pull request.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_ip":{"type":"string","description":"IP for location auto-detection when proxying a request"},"devcontainer_path":{"type":"string","description":"Path to devcontainer.json config to use for this codespace"},"display_name":{"type":"string","description":"Display name for this codespace"},"geo":{"type":"string","description":"The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.","enum":["EuropeWest","SoutheastAsia","UsEast","UsWest"]},"idle_timeout_minutes":{"type":"number","description":"Time in minutes before codespace stops from inactivity"},"location":{"type":"string","description":"The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided."},"machine":{"type":"string","description":"Machine type to use for this codespace"},"multi_repo_permissions_opt_out":{"type":"boolean","description":"Whether to authorize requested permissions from devcontainer.json","enum":[true,false]},"retention_period_minutes":{"type":"number","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)."},"working_directory":{"type":"string","description":"Working directory for this codespace"}}},"example":{"client_ip":"","devcontainer_path":"","display_name":"","geo":"","idle_timeout_minutes":"","location":"","machine":"","multi_repo_permissions_opt_out":"","retention_period_minutes":"","working_directory":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/comments":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort results. Ignored without `sort` parameter.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/comments"},"summary":"List review comments on a pull request","description":"Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/comments"},"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/rest/issues/comments#create-an-issue-comment).\"\n\nIf 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.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"path":{"type":"string","description":"The relative path to the file that necessitates a comment.","required":true},"body":{"type":"string","description":"The text of the review comment.","required":true},"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`.","required":true},"in_reply_to":{"type":"number","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."},"line":{"type":"number","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."},"position":{"type":"number","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."},"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/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.","enum":["LEFT","RIGHT"]},"start_line":{"type":"number","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/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/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"]},"subject_type":{"type":"string","description":"The level at which the comment is targeted.","enum":["line","file"]}}},"example":{"path":"","body":"","commit_id":"","in_reply_to":"","line":"","position":"","side":"","start_line":"","start_side":"","subject_type":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies":{"post":{"tags":["Pulls"],"parameters":[{"name":"comment_id","in":"path","description":"The unique identifier of the comment.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"},"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.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The text of the review comment.","required":true}}},"example":{"body":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/commits":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/commits"},"summary":"List commits on a pull request","description":"Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/pulls/{pull_number}/files":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#list-pull-requests-files","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/files"},"summary":"List pull requests files","description":"Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/pulls/{pull_number}/merge":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/merge"},"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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#merge-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/merge"},"summary":"Merge a pull request","description":"Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/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/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/rest/guides/best-practices-for-using-the-rest-api).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"commit_message":{"type":"string","description":"Extra detail to append to automatic commit message."},"commit_title":{"type":"string","description":"Title for the automatic commit message."},"merge_method":{"type":"string","description":"The merge method to use.","enum":["merge","squash","rebase"]},"sha":{"type":"string","description":"SHA that pull request head must match to allow merge."}}},"example":{"commit_message":"","commit_title":"","merge_method":"","sha":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/merge-async":{"put":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#merge-a-pull-request-asynchronously","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/merge-async"},"summary":"Merge a pull request asynchronously","description":"Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges.\n\nThis is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch.\n\nThe response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used.\n\nIf the pull request is already merged, the merge commit OID will be returned immediately with a 200 status.\n\nIf the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"commit_message":{"type":"string","description":"Extra detail to append to automatic commit message."},"commit_title":{"type":"string","description":"Title for the automatic commit message."},"merge_action":{"type":"string","description":"The action that will be taken to merge the pull request. `direct_merge` merges the pull request directly without using a merge queue; `merge_queue` adds the pull request to a merge queue; `default` selects the most appropriate option.","enum":["default","direct_merge","merge_queue"]},"merge_method":{"type":"string","description":"The merge method to use.","enum":["merge","squash","rebase"]},"sha":{"type":"string","description":"SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled."}}},"example":{"commit_message":"","commit_title":"","merge_action":"","merge_method":"","sha":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"uuid","in":"path","description":"The UUID of the asynchronous merge request, as returned when the merge was requested.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#get-the-result-of-an-asynchronous-merge","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}"},"summary":"Get the result of an asynchronous merge","description":"Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.\n\nWhile the merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure.\n\nThe result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a `404` response for its UUID.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"},"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/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.","security":[{"bearerAuth":[]}]},"post":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"},"summary":"Request reviewers for a pull request","description":"Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/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/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/rest/guides/best-practices-for-using-the-rest-api).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"}}}},"example":{"reviewers":[],"team_reviewers":[]}}}}},"delete":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"reviewers":{"type":"array","description":"An array of user `login`s that will be removed.","required":true,"items":{"type":"string"}},"team_reviewers":{"type":"array","description":"An array of team `slug`s that will be removed.","items":{"type":"string"}}}},"example":{"reviewers":[],"team_reviewers":[]}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/reviews":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/reviews"},"summary":"List reviews for a pull request","description":"Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"post":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/reviews"},"summary":"Create a review for a pull request","description":"Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/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/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/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull 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/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> 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/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review."},"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.","required":true},"body":{"type":"string","description":"Text of the review comment.","required":true},"line":{"type":"number","description":"line"},"position":{"type":"number","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."},"side":{"type":"string","description":"side"},"start_line":{"type":"number","description":"start_line"},"start_side":{"type":"string","description":"start_side"}}}},"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."},"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/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.","enum":["APPROVE","REQUEST_CHANGES","COMMENT"]}}},"example":{"body":"","comments":[],"commit_id":"","event":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"review_id","in":"path","description":"The unique identifier of the review.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"},"summary":"Get a review for a pull request","description":"Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]},"put":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"review_id","in":"path","description":"The unique identifier of the review.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"},"summary":"Update a review for a pull request","description":"Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The body text of the pull request review.","required":true}}},"example":{"body":""}}}}},"delete":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"review_id","in":"path","description":"The unique identifier of the review.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"},"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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"review_id","in":"path","description":"The unique identifier of the review.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"},"summary":"List comments for a pull request review","description":"Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals":{"put":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"review_id","in":"path","description":"The unique identifier of the review.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals"},"summary":"Dismiss a review for a pull request","description":"Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/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.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"event":{"type":"string","description":"event","enum":["DISMISS"]},"message":{"type":"string","description":"The message for the pull request review dismissal","required":true}}},"example":{"event":"","message":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events":{"post":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"review_id","in":"path","description":"The unique identifier of the review.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"},"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/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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.","required":true,"enum":["APPROVE","REQUEST_CHANGES","COMMENT"]}}},"example":{"body":"","event":""}}}}}},"/repos/{owner}/{repo}/pulls/{pull_number}/update-branch":{"put":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pull_number","in":"path","description":"The number that identifies the pull request.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/update-branch"},"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.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref."}}},"example":{"expected_head_sha":""}}}}}},"/repos/{owner}/{repo}/readme":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"query","description":"The name of the commit/branch/tag. Default: the repository’s default branch.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/contents#get-a-repository-readme","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/readme"},"summary":"Get a repository README","description":"Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`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).","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/readme/{dir}":{"get":{"tags":["Repos"],"parameters":[{"name":"dir","in":"path","description":"The alternate path to look for a README file","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"query","description":"The name of the commit/branch/tag. Default: the repository’s default branch.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/readme/{dir}"},"summary":"Get a repository README for a directory","description":"Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`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).","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/releases":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/releases#list-releases","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases"},"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/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/releases#create-a-release","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases"},"summary":"Create a release","description":"Users with push access to the repository can create a release.\n\n> [!NOTE]\n> If the commit identified by `target_commitish` (or, when `target_commitish` is omitted, the latest commit on the default branch) adds or modifies any file under `.github/workflows/` relative to the repository's default branch, the authenticating token must be authorized to modify workflows. Otherwise, this endpoint returns `404 Not Found`; some authentication paths surface `403 Resource not accessible by integration` instead.\n\nOAuth app tokens and personal access tokens (classic) need the `workflow` scope when the resolved target commit modifies workflow files. Fine-grained access tokens and GitHub App installation tokens also need the \"Workflows\" repository permission (write). The `GITHUB_TOKEN` available to GitHub Actions cannot be authorized for this; for more information, see \"[Automatic token authentication](https://docs.github.com/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/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/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/rest/guides/best-practices-for-using-the-rest-api).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"Text describing the contents of the tag."},"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/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""},"draft":{"type":"boolean","description":"`true` to create a draft (unpublished) release, `false` to create a published one.","enum":[true,false]},"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.","enum":[true,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"]},"name":{"type":"string","description":"The name of the release."},"prerelease":{"type":"boolean","description":"`true` to identify the release as a prerelease. `false` to identify the release as a full release.","enum":[true,false]},"tag_name":{"type":"string","description":"The name of the tag.","required":true},"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."}}},"example":{"body":"","discussion_category_name":"","draft":"","generate_release_notes":"","make_latest":"","name":"","prerelease":"","tag_name":"","target_commitish":""}}}}}},"/repos/{owner}/{repo}/releases/assets/{asset_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"asset_id","in":"path","description":"The unique identifier of the asset.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/assets#get-a-release-asset","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/assets/{asset_id}"},"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/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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"asset_id","in":"path","description":"The unique identifier of the asset.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/assets#update-a-release-asset","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/assets/{asset_id}"},"summary":"Update a release asset","description":"Users with push access to the repository can edit a release asset.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"label":{"type":"string","description":"An alternate short description of the asset. Used in place of the filename."},"name":{"type":"string","description":"The file name of the asset."},"state":{"type":"string","description":"state"}}},"example":{"label":"","name":"","state":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"asset_id","in":"path","description":"The unique identifier of the asset.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/assets#delete-a-release-asset","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/assets/{asset_id}"},"summary":"Delete a release asset","description":"Delete a release asset","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/releases/generate-notes":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/generate-notes"},"summary":"Generate release notes content for a release","description":"Generate a name and body describing a [release](https://docs.github.com/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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."},"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."},"tag_name":{"type":"string","description":"The tag name for the release. This can be an existing tag or a new one.","required":true},"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."}}},"example":{"configuration_file_path":"","previous_tag_name":"","tag_name":"","target_commitish":""}}}}}},"/repos/{owner}/{repo}/releases/latest":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/releases#get-the-latest-release","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/latest"},"summary":"Get the latest release","description":"View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/releases/tags/{tag}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"tag","in":"path","description":"tag parameter","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/tags/{tag}"},"summary":"Get a release by tag name","description":"Get a published release with the specified tag.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/releases/{release_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"release_id","in":"path","description":"The unique identifier of the release.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/releases#get-a-release","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/{release_id}"},"summary":"Get a release","description":"Gets a public release with the specified release ID.\n\n> [!NOTE]\n> 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/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"","security":[{"bearerAuth":[]}]},"patch":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"release_id","in":"path","description":"The unique identifier of the release.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/releases#update-a-release","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/{release_id}"},"summary":"Update a release","description":"Users with push access to the repository can edit a release.\n\n> [!NOTE]\n> If the resolved target commit (the new value of `target_commitish` if you are changing it, otherwise the existing target) adds or modifies any file under `.github/workflows/` relative to the repository's default branch, the authenticating token must be authorized to modify workflows. Otherwise, this endpoint returns `404 Not Found`; some authentication paths surface `403 Resource not accessible by integration` instead.\n\nOAuth app tokens and personal access tokens (classic) need the `workflow` scope when the resolved target commit modifies workflow files. Fine-grained access tokens and GitHub App installation tokens also need the \"Workflows\" repository permission (write). The `GITHUB_TOKEN` available to GitHub Actions cannot be authorized for this; for more information, see \"[Automatic token authentication](https://docs.github.com/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"Text describing the contents of the tag."},"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/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""},"draft":{"type":"boolean","description":"`true` makes the release a draft, and `false` publishes the release.","enum":[true,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"]},"name":{"type":"string","description":"The name of the release."},"prerelease":{"type":"boolean","description":"`true` to identify the release as a prerelease, `false` to identify the release as a full release.","enum":[true,false]},"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."}}},"example":{"body":"","discussion_category_name":"","draft":"","make_latest":"","name":"","prerelease":"","tag_name":"","target_commitish":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"release_id","in":"path","description":"The unique identifier of the release.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/releases#delete-a-release","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/{release_id}"},"summary":"Delete a release","description":"Users with push access to the repository can delete a release.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/releases/{release_id}/assets":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"release_id","in":"path","description":"The unique identifier of the release.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/assets#list-release-assets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/{release_id}/assets"},"summary":"List release assets","description":"List release assets","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"release_id","in":"path","description":"The unique identifier of the release.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"label","in":"query","description":"label","schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/releases/assets#upload-a-release-asset","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/{release_id}/assets"},"summary":"Upload a release asset","description":"This endpoint makes use of a [Hypermedia relation](https://docs.github.com/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/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 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 renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub 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/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/releases/{release_id}/reactions":{"get":{"tags":["Reactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"release_id","in":"path","description":"The unique identifier of the release.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"content","in":"query","description":"Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.","schema":{"type":"string","example":"","items":{"type":"string","enum":["+1","laugh","heart","hooray","rocket","eyes"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/{release_id}/reactions"},"summary":"List reactions for a release","description":"List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).","security":[{"bearerAuth":[]}]},"post":{"tags":["Reactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"release_id","in":"path","description":"The unique identifier of the release.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/{release_id}/reactions"},"summary":"Create reaction for a release","description":"Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release.","required":true,"enum":["+1","laugh","heart","hooray","rocket","eyes"]}}},"example":{"content":""}}}}}},"/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}":{"delete":{"tags":["Reactions"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"reaction_id","in":"path","description":"The unique identifier of the reaction.","required":true,"schema":{"type":"number","example":""}},{"name":"release_id","in":"path","description":"The unique identifier of the release.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"},"summary":"Delete a release reaction","description":"> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/rules/branches/{branch}":{"get":{"tags":["Repos"],"parameters":[{"name":"branch","in":"path","description":"The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rules#get-rules-for-a-branch","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rules/branches/{branch}"},"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\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/rulesets":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"includes_parents","in":"query","description":"Include rulesets configured at higher levels that apply to this repository","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"targets","in":"query","description":"A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rules#get-all-repository-rulesets","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets"},"summary":"Get all repository rulesets","description":"Get all the rulesets for a repository.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rules#create-a-repository-ruleset","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets"},"summary":"Create a repository ruleset","description":"Create a ruleset for a repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bypass_actors":{"type":"array","description":"The actors that can bypass the rules in this ruleset","items":{"type":"object","properties":{"actor_id":{"type":"number","description":"The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories."},"actor_type":{"type":"string","description":"The type of actor that can bypass a ruleset.","required":true,"enum":["Integration","OrganizationAdmin","RepositoryRole","Team","DeployKey","User"]},"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"]}}}},"conditions":{"type":"object","description":"Parameters for a repository ruleset ref name condition","properties":{"ref_name":{"type":"object","description":"ref_name"}}},"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 only available with GitHub Enterprise).","required":true,"enum":["disabled","active","evaluate"]},"name":{"type":"string","description":"The name of the ruleset.","required":true},"rules":{"type":"array","description":"An array of rules within the ruleset.","items":{"type":"object","properties":{}}},"target":{"type":"string","description":"The target of the ruleset","enum":["branch","tag","push"]}}},"example":{"bypass_actors":[],"conditions":{},"enforcement":"","name":"","rules":[],"target":""}}}}}},"/repos/{owner}/{repo}/rulesets/rule-suites":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"actor_name","in":"query","description":"The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.","schema":{"type":"string","example":""}},{"name":"evaluate_status","in":"query","description":"The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned.\n  - `all` - all rule suites will be returned.\n  - `active` - only rule suites resulting from rulesets in active (non-evaluate) mode will be returned.\n  - `evaluate` - only rule suites resulting from rulesets in evaluate mode will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","active","evaluate"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"ref","in":"query","description":"The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.","schema":{"type":"string","example":""}},{"name":"rule_suite_result","in":"query","description":"The rule suite results to filter on. When specified, only suites with this result will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["pass","fail","bypass","all"]}}},{"name":"time_period","in":"query","description":"The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).","schema":{"type":"string","example":"","items":{"type":"string","enum":["hour","day","week","month"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets/rule-suites"},"summary":"List repository rule suites","description":"Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"rule_suite_id","in":"path","description":"The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}"},"summary":"Get a repository rule suite","description":"Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/rulesets/{ruleset_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}},{"name":"includes_parents","in":"query","description":"Include rulesets configured at higher levels that apply to this repository","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rules#get-a-repository-ruleset","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets/{ruleset_id}"},"summary":"Get a repository ruleset","description":"Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rules#update-a-repository-ruleset","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets/{ruleset_id}"},"summary":"Update a repository ruleset","description":"Update a ruleset for a repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bypass_actors":{"type":"array","description":"The actors that can bypass the rules in this ruleset","items":{"type":"object","properties":{"actor_id":{"type":"number","description":"The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories."},"actor_type":{"type":"string","description":"The type of actor that can bypass a ruleset.","required":true,"enum":["Integration","OrganizationAdmin","RepositoryRole","Team","DeployKey","User"]},"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"]}}}},"conditions":{"type":"object","description":"Parameters for a repository ruleset ref name condition","properties":{"ref_name":{"type":"object","description":"ref_name"}}},"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 only available with GitHub Enterprise).","enum":["disabled","active","evaluate"]},"name":{"type":"string","description":"The name of the ruleset."},"rules":{"type":"array","description":"An array of rules within the ruleset.","items":{"type":"object","properties":{}}},"target":{"type":"string","description":"The target of the ruleset","enum":["branch","tag","push"]}}},"example":{"bypass_actors":[],"conditions":{},"enforcement":"","name":"","rules":[],"target":""}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets/{ruleset_id}"},"summary":"Delete a repository ruleset","description":"Delete a ruleset for a repository.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/rulesets/{ruleset_id}/history":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rules#get-repository-ruleset-history","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets/{ruleset_id}/history"},"summary":"Get repository ruleset history","description":"Get the history of a repository ruleset.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ruleset_id","in":"path","description":"The ID of the ruleset.","required":true,"schema":{"type":"number","example":""}},{"name":"version_id","in":"path","description":"The ID of the version","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/rules#get-repository-ruleset-version","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}"},"summary":"Get repository ruleset version","description":"Get a version of a repository ruleset.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/secret-scanning/alerts":{"get":{"tags":["Secret Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.  To receive an initial cursor on your first request, include an empty \"after\" query string.","schema":{"type":"string","example":""}},{"name":"assignee","in":"query","description":"Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"exclude_providers","in":"query","description":"A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.","schema":{"type":"string","example":""}},{"name":"exclude_secret_types","in":"query","description":"A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.","schema":{"type":"string","example":""}},{"name":"hide_secret","in":"query","description":"A boolean value representing whether or not to hide literal secrets in the results.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"included_metadata","in":"query","description":"A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the\nspecified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`,\n`owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`,\n`organization-id`, `last-used-date`, and `has-organization-access`.","schema":{"type":"string","example":""}},{"name":"is_bypassed","in":"query","description":"A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be returned.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"is_multi_repo","in":"query","description":"A boolean value representing whether or not to filter alerts by the multi-repo tag being present.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"is_publicly_leaked","in":"query","description":"A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"owner_email_hash","in":"query","description":"Filters alerts to only those whose attached `owner_email` metadata field matches the\nprovided value. The value must be the lowercase hex-encoded SHA-256 hash of the email\naddress to match (for example, the SHA-256 of `user@example.com`). Only alerts that\nhave an `owner_email` metadata value whose SHA-256 hash equals this parameter are\nreturned.","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"providers","in":"query","description":"A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.","schema":{"type":"string","example":""}},{"name":"resolution","in":"query","description":"A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.","schema":{"type":"string","example":""}},{"name":"secret_type","in":"query","description":"A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}},{"name":"state","in":"query","description":"Set to `open` or `resolved` to only list secret scanning alerts in a specific state.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","resolved"]}}},{"name":"validity","in":"query","description":"A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/alerts"},"summary":"List secret scanning alerts for a repository","description":"Lists secret scanning alerts for an eligible repository, from newest to oldest.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}":{"get":{"tags":["Secret Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"hide_secret","in":"query","description":"A boolean value representing whether or not to hide literal secrets in the results.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"},"summary":"Get a secret scanning alert","description":"Gets a single secret scanning alert detected in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Secret Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"},"summary":"Update a secret scanning alert","description":"Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"assignee":{"type":"string","description":"The username of the user to assign to the alert. Set to `null` to unassign the alert."},"resolution":{"type":"string","description":"**Required when the `state` is `resolved`.** The reason for resolving the alert.","enum":["false_positive","wont_fix","revoked","used_in_tests"]},"resolution_comment":{"type":"string","description":"An optional comment when closing or reopening an alert. Cannot be updated or deleted."},"state":{"type":"string","description":"Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.","enum":["open","resolved"]},"validity":{"type":"string","description":"Sets the validity of the secret scanning alert. Can be `active`, `inactive`, or `null` to clear the override.","enum":["active","inactive"]}}},"example":{"assignee":"","resolution":"","resolution_comment":"","state":"","validity":""}}}}}},"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations":{"get":{"tags":["Secret Scanning"],"parameters":[{"name":"alert_number","in":"path","description":"The security alert number.","required":true,"schema":{"type":"number","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations"},"summary":"List locations for a secret scanning alert","description":"Lists all locations for a given secret scanning alert for an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/secret-scanning/custom-patterns":{"get":{"tags":["Secret Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"push_protection","in":"query","description":"Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.","schema":{"type":"string","example":"","items":{"type":"string","enum":["enabled","disabled"]}}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","name"]}}},{"name":"state","in":"query","description":"Filter custom patterns by state. When absent, returns patterns in all states.","schema":{"type":"string","example":"","items":{"type":"string","enum":["published","unpublished"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/custom-patterns"},"summary":"List repository custom patterns","description":"Lists secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.\n\nFine-grained access tokens require the `administration:write` repository permission.","security":[{"bearerAuth":[]}]},"post":{"tags":["Secret Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/custom-patterns"},"summary":"Bulk create repository custom patterns","description":"Bulk creates secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.\n\nFine-grained access tokens require the `administration:write` repository permission.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"patterns":{"type":"array","description":"The list of custom patterns to create.","required":true,"items":{"type":"object","properties":{"end_delimiter":{"type":"string","description":"The end delimiter regex for the custom pattern.\nDefaults to `\\z|[^0-9A-Za-z]` when not specified."},"must_match":{"type":"array","description":"List of regexes that the secret must match."},"must_not_match":{"type":"array","description":"List of regexes that the secret must not match."},"name":{"type":"string","description":"The name of the custom pattern.","required":true},"pattern":{"type":"string","description":"The regular expression of the custom pattern.","required":true},"start_delimiter":{"type":"string","description":"The start delimiter regex for the custom pattern.\nDefaults to `\\A|[^0-9A-Za-z]` when not specified."}}}}}},"example":{"patterns":[]}}}}},"delete":{"tags":["Secret Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/custom-patterns"},"summary":"Bulk delete repository custom patterns","description":"Bulk deletes secret scanning custom patterns for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.\n\nFine-grained access tokens require the `administration:write` repository permission.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"patterns":{"type":"array","description":"The list of custom patterns to delete.","required":true,"items":{"type":"object","properties":{"custom_pattern_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."},"pattern_id":{"type":"number","description":"The ID of the custom pattern to delete.","required":true}}}},"post_delete_action":{"type":"string","description":"What to do with alerts associated with the deleted patterns.\n`delete_alerts` permanently removes the alerts.\n`resolve_alerts` resolves the alerts as \"pattern deleted\".\nDefaults to `delete_alerts` when not specified.","enum":["delete_alerts","resolve_alerts"]}}},"example":{"patterns":[],"post_delete_action":""}}}}}},"/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}":{"patch":{"tags":["Secret Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"pattern_id","in":"path","description":"The ID of the custom pattern.","required":true,"schema":{"type":"number","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}"},"summary":"Update a repository custom pattern","description":"Updates a secret scanning custom pattern for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.\n\nFine-grained access tokens require the `administration:write` repository permission.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_pattern_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.","required":true},"end_delimiter":{"type":"string","description":"The updated end delimiter regex for the custom pattern."},"must_match":{"type":"array","description":"Updated list of regexes that the secret must match.","items":{"type":"string"}},"must_not_match":{"type":"array","description":"Updated list of regexes that the secret must not match.","items":{"type":"string"}},"pattern":{"type":"string","description":"The updated regular expression of the custom pattern."},"start_delimiter":{"type":"string","description":"The updated start delimiter regex for the custom pattern."}}},"example":{"custom_pattern_version":"","end_delimiter":"","must_match":[],"must_not_match":[],"pattern":"","start_delimiter":""}}}}}},"/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses":{"post":{"tags":["Secret Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses"},"summary":"Create a push protection bypass","description":"Creates a bypass for a previously push protected secret.\n\nThe authenticated user must be the original author of the committed secret.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"placeholder_id":{"type":"string","description":"The ID of the push protection bypass placeholder. This value is returned on any push protected routes.","required":true},"reason":{"type":"string","description":"The reason for bypassing push protection.","required":true,"enum":["false_positive","used_in_tests","will_fix_later"]}}},"example":{"placeholder_id":"","reason":""}}}}}},"/repos/{owner}/{repo}/secret-scanning/scan-history":{"get":{"tags":["Secret Scanning"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/secret-scanning/scan-history"},"summary":"Get secret scanning scan history for a repository","description":"Lists the latest default incremental and backfill scans by type for a repository.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/security-advisories":{"get":{"tags":["Security Advisories"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"per_page","in":"query","description":"The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","published"]}}},{"name":"state","in":"query","description":"Filter by state of the repository advisories. Only advisories of this state will be returned.","schema":{"type":"string","example":"","items":{"type":"string","enum":["triage","draft","published","closed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/security-advisories"},"summary":"List repository security advisories","description":"Lists security advisories in a repository.\n\nThe 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.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"post":{"tags":["Security Advisories"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/security-advisories"},"summary":"Create a repository security advisory","description":"Creates a new repository security advisory.\n\nIn order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"credits":{"type":"array","description":"A list of users receiving credit for their participation in the security advisory.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of credit the user is receiving.","required":true,"enum":["analyst","finder","reporter","coordinator","remediation_developer","remediation_reviewer","remediation_verifier","tool","sponsor","other"]},"login":{"type":"string","description":"The username of the user credited.","required":true}}}},"cve_id":{"type":"string","description":"The Common Vulnerabilities and Exposures (CVE) ID."},"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`."},"cwe_ids":{"type":"array","description":"A list of Common Weakness Enumeration (CWE) IDs.","items":{"type":"string"}},"description":{"type":"string","description":"A detailed description of what the advisory impacts.","required":true},"severity":{"type":"string","description":"The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.","enum":["critical","high","medium","low"]},"start_private_fork":{"type":"boolean","description":"Whether to create a temporary private fork of the repository to collaborate on a fix.","enum":[true,false]},"summary":{"type":"string","description":"A short summary of the advisory.","required":true},"vulnerabilities":{"type":"array","description":"A product affected by the vulnerability detailed in a repository security advisory.","required":true,"items":{"type":"object","properties":{"package":{"type":"object","description":"The name of the package affected by the vulnerability.","required":true},"patched_versions":{"type":"string","description":"The package version(s) that resolve the vulnerability."},"vulnerable_functions":{"type":"array","description":"The functions in the package that are affected."},"vulnerable_version_range":{"type":"string","description":"The range of the package versions affected by the vulnerability."}}}}}},"example":{"credits":[],"cve_id":"","cvss_vector_string":"","cwe_ids":[],"description":"","severity":"","start_private_fork":"","summary":"","vulnerabilities":[]}}}}}},"/repos/{owner}/{repo}/security-advisories/reports":{"post":{"tags":["Security Advisories"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/security-advisories/reports"},"summary":"Privately report a security vulnerability","description":"Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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`."},"cwe_ids":{"type":"array","description":"A list of Common Weakness Enumeration (CWE) IDs.","items":{"type":"string"}},"description":{"type":"string","description":"A detailed description of what the advisory impacts.","required":true},"severity":{"type":"string","description":"The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.","enum":["critical","high","medium","low"]},"start_private_fork":{"type":"boolean","description":"Whether to create a temporary private fork of the repository to collaborate on a fix.","enum":[true,false]},"summary":{"type":"string","description":"A short summary of the advisory.","required":true},"vulnerabilities":{"type":"array","description":"An array of products affected by the vulnerability detailed in a repository security advisory.","items":{"type":"object","properties":{"package":{"type":"object","description":"The name of the package affected by the vulnerability.","required":true},"patched_versions":{"type":"string","description":"The package version(s) that resolve the vulnerability."},"vulnerable_functions":{"type":"array","description":"The functions in the package that are affected."},"vulnerable_version_range":{"type":"string","description":"The range of the package versions affected by the vulnerability."}}}}}},"example":{"cvss_vector_string":"","cwe_ids":[],"description":"","severity":"","start_private_fork":"","summary":"","vulnerabilities":[]}}}}}},"/repos/{owner}/{repo}/security-advisories/{ghsa_id}":{"get":{"tags":["Security Advisories"],"parameters":[{"name":"ghsa_id","in":"path","description":"The GHSA (GitHub Security Advisory) identifier of the advisory.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/security-advisories/{ghsa_id}"},"summary":"Get a repository security advisory","description":"Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nAnyone can access any published security advisory on a public repository.\n\nThe 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\ncollaborator on the security advisory.\n\nOAuth 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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Security Advisories"],"parameters":[{"name":"ghsa_id","in":"path","description":"The GHSA (GitHub Security Advisory) identifier of the advisory.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/security-advisories/{ghsa_id}"},"summary":"Update a repository security advisory","description":"Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nIn order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,\nor a collaborator on the repository security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"collaborating_teams":{"type":"array","description":"A list of team slugs which have been granted write access to the advisory.","items":{"type":"string"}},"collaborating_users":{"type":"array","description":"A list of usernames who have been granted write access to the advisory.","items":{"type":"string"}},"credits":{"type":"array","description":"A list of users receiving credit for their participation in the security advisory.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of credit the user is receiving.","required":true,"enum":["analyst","finder","reporter","coordinator","remediation_developer","remediation_reviewer","remediation_verifier","tool","sponsor","other"]},"login":{"type":"string","description":"The username of the user credited.","required":true}}}},"cve_id":{"type":"string","description":"The Common Vulnerabilities and Exposures (CVE) ID."},"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`."},"cwe_ids":{"type":"array","description":"A list of Common Weakness Enumeration (CWE) IDs.","items":{"type":"string"}},"description":{"type":"string","description":"A detailed description of what the advisory impacts."},"severity":{"type":"string","description":"The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.","enum":["critical","high","medium","low"]},"state":{"type":"string","description":"The state of the advisory.","enum":["published","closed","draft"]},"summary":{"type":"string","description":"A short summary of the advisory."},"vulnerabilities":{"type":"array","description":"A product affected by the vulnerability detailed in a repository security advisory.","items":{"type":"object","properties":{"package":{"type":"object","description":"The name of the package affected by the vulnerability.","required":true},"patched_versions":{"type":"string","description":"The package version(s) that resolve the vulnerability."},"vulnerable_functions":{"type":"array","description":"The functions in the package that are affected."},"vulnerable_version_range":{"type":"string","description":"The range of the package versions affected by the vulnerability."}}}}}},"example":{"collaborating_teams":[],"collaborating_users":[],"credits":[],"cve_id":"","cvss_vector_string":"","cwe_ids":[],"description":"","severity":"","state":"","summary":"","vulnerabilities":[]}}}}}},"/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve":{"post":{"tags":["Security Advisories"],"parameters":[{"name":"ghsa_id","in":"path","description":"The GHSA (GitHub Security Advisory) identifier of the advisory.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"},"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/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nIn order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks":{"post":{"tags":["Security Advisories"],"parameters":[{"name":"ghsa_id","in":"path","description":"The GHSA (GitHub Security Advisory) identifier of the advisory.","required":true,"schema":{"type":"string","example":""}},{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks"},"summary":"Create a temporary private fork","description":"Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n> [!NOTE]\n> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/stacks":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"pull_request","in":"query","description":"Filter to the stack containing this repository pull request number.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/stacks#list-pull-request-stacks","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stacks"},"summary":"List pull request stacks","description":"Lists pull request stacks in a repository.","security":[{"bearerAuth":[]}]},"post":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/stacks#create-a-pull-request-stack","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stacks"},"summary":"Create a pull request stack","description":"Creates a stack from an ordered list of pull request numbers. Provide the pull\nrequest numbers from the bottom of the stack to the top. Each pull request's\nbase ref must match the previous pull request's head ref.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pull_requests":{"type":"array","description":"An ordered list of pull request numbers forming the stack from bottom to top.","required":true,"items":{"type":"number"}}}},"example":{"pull_requests":[]}}}}}},"/repos/{owner}/{repo}/stacks/{stack_number}":{"get":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"stack_number","in":"path","description":"The number that identifies the pull request stack.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/stacks#get-a-pull-request-stack","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stacks/{stack_number}"},"summary":"Get a pull request stack","description":"Gets a pull request stack by providing its stack number.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/stacks/{stack_number}/add":{"post":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"stack_number","in":"path","description":"The number that identifies the pull request stack.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/stacks#add-pull-requests-to-a-pull-request-stack","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stacks/{stack_number}/add"},"summary":"Add pull requests to a pull request stack","description":"Appends an ordered list of pull request numbers onto the top of an existing\nstack. Provide only the pull requests you want to add, from the current top of\nthe stack upward. The first new pull request's base ref must match the current\ntop pull request's head ref.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pull_requests":{"type":"array","description":"An ordered list of pull request numbers to append to the stack, from the current top upward.","required":true,"items":{"type":"number"}}}},"example":{"pull_requests":[]}}}}}},"/repos/{owner}/{repo}/stacks/{stack_number}/unstack":{"post":{"tags":["Pulls"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"stack_number","in":"path","description":"The number that identifies the pull request stack.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/pulls/stacks#remove-pull-requests-from-a-pull-request-stack","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stacks/{stack_number}/unstack"},"summary":"Remove pull requests from a pull request stack","description":"Removes the unmerged pull requests from a stack. Pull requests that cannot be\nunstacked (for example, those that are queued for merge) are left in place. When pull requests remain in the stack, the updated\nstack is returned with a `200`. When no pull requests remain, the stack is\ndissolved and a `204` is returned.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/stargazers":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/starring#list-stargazers","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stargazers"},"summary":"List stargazers","description":"Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/stargazers/count":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/starring#get-stargazer-count","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stargazers/count"},"summary":"Get stargazer count","description":"Gets the current number of users who have starred the repository. Users who previously starred the repository but later removed their star are not included.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/stargazers/history":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/starring#get-repository-star-history","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stargazers/history"},"summary":"Get repository star history","description":"Returns repository stars grouped by calendar weeks, most recent first. Pages move backward toward the repository's creation week, and weeks within a page are ordered newest to oldest, so concatenating pages produces one continuous series. Weeks without stars contain zero counts. Week and day boundaries are not guaranteed to align with UTC. The `days` array contains the number of stars created on each day of the week, starting on Sunday.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/stats/code_frequency":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stats/code_frequency"},"summary":"Get the weekly commit activity","description":"Returns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/stats/commit_activity":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stats/commit_activity"},"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`.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/stats/contributors":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stats/contributors"},"summary":"Get all contributor commit activity","description":"\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n*   `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n*   `a` - Number of additions\n*   `d` - Number of deletions\n*   `c` - Number of commits\n\n> [!NOTE]\n> This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/stats/participation":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stats/participation"},"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`.\n\nThe array order is oldest week (index 0) to most recent week.\n\nThe most recent week is seven days ago at UTC midnight to today at UTC midnight.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/stats/punch_card":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/stats/punch_card"},"summary":"Get the hourly commit count for each day","description":"Each array contains the day number, hour number, and number of commits:\n\n*   `0-6`: Sunday - Saturday\n*   `0-23`: Hour of day\n*   Number of commits\n\nFor 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/statuses/{sha}":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"sha","in":"path","description":"sha","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/commits/statuses#create-a-commit-status","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/statuses/{sha}"},"summary":"Create a commit status","description":"Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"context":{"type":"string","description":"A string label to differentiate this status from the status of other systems. This field is case-insensitive."},"description":{"type":"string","description":"A short description of the status."},"state":{"type":"string","description":"The state of the status.","required":true,"enum":["error","failure","pending","success"]},"target_url":{"type":"string","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`"}}},"example":{"context":"","description":"","state":"","target_url":""}}}}}},"/repos/{owner}/{repo}/subscribers":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/watching#list-watchers","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/subscribers"},"summary":"List watchers","description":"Lists the people watching the specified repository.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/subscription":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/watching#get-a-repository-subscription","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/subscription"},"summary":"Get a repository subscription","description":"Gets information about whether the authenticated user is subscribed to the repository.","security":[{"bearerAuth":[]}]},"put":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/watching#set-a-repository-subscription","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/subscription"},"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/rest/activity/watching#delete-a-repository-subscription) completely.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ignored":{"type":"boolean","description":"Determines if all notifications should be blocked from this repository.","enum":[true,false]},"subscribed":{"type":"boolean","description":"Determines if notifications should be received from this repository.","enum":[true,false]}}},"example":{"ignored":"","subscribed":""}}}}},"delete":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/watching#delete-a-repository-subscription","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/subscription"},"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/rest/activity/watching#set-a-repository-subscription).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/tags":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-repository-tags","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/tags"},"summary":"List repository tags","description":"List repository tags","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/tarball/{ref}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"ref","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/tarball/{ref}"},"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\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/teams":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-repository-teams","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/teams"},"summary":"List repository teams","description":"Lists the teams that have access to the specified repository and that are also visible to the authenticated user.\n\nFor a public repository, a team is listed only if that team added the public repository explicitly.\n\nOAuth 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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/topics":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#get-all-repository-topics","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/topics"},"summary":"Get all repository topics","description":"Get all repository topics","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#replace-all-repository-topics","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/topics"},"summary":"Replace all repository topics","description":"Replace all repository topics","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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.","required":true,"items":{"type":"string"}}}},"example":{"names":[]}}}}}},"/repos/{owner}/{repo}/traffic/clones":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"per","in":"query","description":"The time frame to display results for.","schema":{"type":"string","example":"","items":{"type":"string","enum":["day","week"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/traffic#get-repository-clones","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/traffic/clones"},"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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/traffic/popular/paths":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/traffic#get-top-referral-paths","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/traffic/popular/paths"},"summary":"Get top referral paths","description":"Get the top 10 popular contents over the last 14 days.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/traffic/popular/referrers":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/traffic#get-top-referral-sources","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/traffic/popular/referrers"},"summary":"Get top referral sources","description":"Get the top 10 referrers over the last 14 days.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/traffic/views":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"per","in":"query","description":"The time frame to display results for.","schema":{"type":"string","example":"","items":{"type":"string","enum":["day","week"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/metrics/traffic#get-page-views","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/traffic/views"},"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.","security":[{"bearerAuth":[]}]}},"/repos/{owner}/{repo}/transfer":{"post":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#transfer-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/transfer"},"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/articles/about-repository-transfers/).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"new_name":{"type":"string","description":"The new name to be given to the repository."},"new_owner":{"type":"string","description":"The username or organization name the repository will be transferred to.","required":true},"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":"number"}}}},"example":{"new_name":"","new_owner":"","team_ids":[]}}}}}},"/repos/{owner}/{repo}/vulnerability-alerts":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/vulnerability-alerts"},"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/articles/about-security-alerts-for-vulnerable-dependencies)\".","security":[{"bearerAuth":[]}]},"put":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/vulnerability-alerts"},"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/articles/about-security-alerts-for-vulnerable-dependencies)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/vulnerability-alerts"},"summary":"Disable vulnerability alerts","description":"Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/repos/{owner}/{repo}/zipball/{ref}":{"get":{"tags":["Repos"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"ref","in":"path","description":"ref","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip","api_endpoint":"https://api.github.com/repos/{owner}/{repo}/zipball/{ref}"},"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\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/repos/{template_owner}/{template_repo}/generate":{"post":{"tags":["Repos"],"parameters":[{"name":"template_owner","in":"path","description":"The account owner of the template repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"template_repo","in":"path","description":"The name of the template repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template","api_endpoint":"https://api.github.com/repos/{template_owner}/{template_repo}/generate"},"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/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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`.","enum":[true,false]},"name":{"type":"string","description":"The name of the new repository.","required":true},"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."},"private":{"type":"boolean","description":"Either `true` to create a new private repository or `false` to create a new public one.","enum":[true,false]}}},"example":{"description":"","include_all_branches":"","name":"","owner":"","private":""}}}}}},"/repositories":{"get":{"tags":["Repos"],"parameters":[{"name":"since","in":"query","description":"A repository ID. Only return repositories with an ID greater than this ID.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-public-repositories","api_endpoint":"https://api.github.com/repositories"},"summary":"List public repositories","description":"Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.","security":[{"bearerAuth":[]}]}},"/search/code":{"get":{"tags":["Search"],"parameters":[{"name":"order","in":"query","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`. ","schema":{"type":"string","example":"","items":{"type":"string","enum":["desc","asc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.","required":true,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","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 search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","schema":{"type":"string","example":"","items":{"type":"string","enum":["indexed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/search/search#search-code","api_endpoint":"https://api.github.com/search/code"},"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/rest/guides/using-pagination-in-the-rest-api).\n\nWhen 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/rest/search/search#text-match-metadata).\n\nFor 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:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis 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.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n*   Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n*   Only files smaller than 384 KB are searchable.\n*   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\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.","security":[{"bearerAuth":[]}]}},"/search/commits":{"get":{"tags":["Search"],"parameters":[{"name":"order","in":"query","description":"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`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["desc","asc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.","required":true,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","schema":{"type":"string","example":"","items":{"type":"string","enum":["author-date","committer-date"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/search/search#search-commits","api_endpoint":"https://api.github.com/search/commits"},"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/rest/guides/using-pagination-in-the-rest-api).\n\nWhen 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\nmetadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor 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:\n\n`q=repo:octocat/Spoon-Knife+css`","security":[{"bearerAuth":[]}]}},"/search/issues":{"get":{"tags":["Search"],"parameters":[{"name":"advanced_search","in":"query","description":"Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`","schema":{"type":"string","example":""}},{"name":"order","in":"query","description":"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`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["desc","asc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.","required":true,"schema":{"type":"string","example":""}},{"name":"search_type","in":"query","description":"The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).","schema":{"type":"string","example":"","items":{"type":"string","enum":["semantic","hybrid"]}}},{"name":"sort","in":"query","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/rest/search/search#ranking-search-results)","schema":{"type":"string","example":"","items":{"type":"string","enum":["comments","reactions","reactions-+1","reactions--1","reactions-smile","reactions-thinking_face","reactions-heart","reactions-tada","interactions","created","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/search/search#search-issues-and-pull-requests","api_endpoint":"https://api.github.com/search/issues"},"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/rest/guides/using-pagination-in-the-rest-api).\n\nWhen 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\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis 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.\n\n> [!NOTE]\n> 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/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"","security":[{"bearerAuth":[]}]}},"/search/labels":{"get":{"tags":["Search"],"parameters":[{"name":"order","in":"query","description":"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`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["desc","asc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","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/rest/search/search#constructing-a-search-query).","required":true,"schema":{"type":"string","example":""}},{"name":"repository_id","in":"query","description":"The id of the repository.","required":true,"schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/search/search#search-labels","api_endpoint":"https://api.github.com/search/labels"},"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/rest/guides/using-pagination-in-the-rest-api).\n\nWhen 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/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.","security":[{"bearerAuth":[]}]}},"/search/repositories":{"get":{"tags":["Search"],"parameters":[{"name":"order","in":"query","description":"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`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["desc","asc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.","required":true,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","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/rest/search/search#ranking-search-results)","schema":{"type":"string","example":"","items":{"type":"string","enum":["stars","forks","help-wanted-issues","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/search/search#search-repositories","api_endpoint":"https://api.github.com/search/repositories"},"summary":"Search repositories","description":"Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen 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/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis 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.","security":[{"bearerAuth":[]}]}},"/search/topics":{"get":{"tags":["Search"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/search/search#search-topics","api_endpoint":"https://api.github.com/search/topics"},"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/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen 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/rest/search/search#text-match-metadata).\n\nFor 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:\n\n`q=ruby+is:featured`\n\nThis 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.","security":[{"bearerAuth":[]}]}},"/search/users":{"get":{"tags":["Search"],"parameters":[{"name":"order","in":"query","description":"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`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["desc","asc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.","required":true,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)","schema":{"type":"string","example":"","items":{"type":"string","enum":["followers","repositories","joined"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/search/search#search-users","api_endpoint":"https://api.github.com/search/users"},"summary":"Search users","description":"Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen 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/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis 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/graphql/reference/queries#search).\"","security":[{"bearerAuth":[]}]}},"/teams/{team_id}":{"get":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#get-a-team-legacy","api_endpoint":"https://api.github.com/teams/{team_id}"},"summary":"Get a team (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/teams#get-a-team-by-name) endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#update-a-team-legacy","api_endpoint":"https://api.github.com/teams/{team_id}"},"summary":"Update a team (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the team."},"name":{"type":"string","description":"The name of the team.","required":true},"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"]},"parent_team_id":{"type":"number","description":"The ID of a team to set as the parent team."},"parent_team_slug":{"type":"string","description":"The slug of a team to set as the parent team. Ignored when `parent_team_id` is also provided."},"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"]},"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"]}}},"example":{"description":"","name":"","notification_setting":"","parent_team_id":"","parent_team_slug":"","permission":"","privacy":""}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#delete-a-team-legacy","api_endpoint":"https://api.github.com/teams/{team_id}"},"summary":"Delete a team (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/teams/{team_id}/invitations":{"get":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/invitations"},"summary":"List pending team invitations (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe 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 member, the `login` field in the return hash will be `null`.","security":[{"bearerAuth":[]}]}},"/teams/{team_id}/members":{"get":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"role","in":"query","description":"Filters members returned by their role in the team.","schema":{"type":"string","example":"","items":{"type":"string","enum":["member","maintainer","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#list-team-members-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/members"},"summary":"List team members (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.\n\nEach member includes their `role` on the team (`member` or `maintainer`) and an `inherited` flag indicating whether the membership is inherited from a child team (`true`) or is a direct membership (`false`).","security":[{"bearerAuth":[]}]}},"/teams/{team_id}/members/{username}":{"get":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#get-team-member-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/members/{username}"},"summary":"Get team member (Legacy)","description":"The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.","security":[{"bearerAuth":[]}]},"put":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#add-team-member-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/members/{username}"},"summary":"Add team member (Legacy)","description":"The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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.\n\n> [!NOTE]\n> 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 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](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote 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/rest/guides/getting-started-with-the-rest-api#http-method).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#remove-team-member-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/members/{username}"},"summary":"Remove team member (Legacy)","description":"The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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.\n\n> [!NOTE]\n> 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 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](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/teams/{team_id}/memberships/{username}":{"get":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/memberships/{username}"},"summary":"Get team membership for a user (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).","security":[{"bearerAuth":[]}]},"put":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/memberships/{username}"},"summary":"Add or update team membership for a user (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf 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.\n\n> [!NOTE]\n> 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 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](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf 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.\n\nIf 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"role":{"type":"string","description":"The role that this user should have in the team.","enum":["member","maintainer"]}}},"example":{"role":""}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/memberships/{username}"},"summary":"Remove team membership for a user (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo 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.\n\n> [!NOTE]\n> 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 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](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/teams/{team_id}/repos":{"get":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#list-team-repositories-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/repos"},"summary":"List team repositories (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/teams#list-team-repositories) endpoint.","security":[{"bearerAuth":[]}]}},"/teams/{team_id}/repos/{owner}/{repo}":{"get":{"tags":["Teams"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/repos/{owner}/{repo}"},"summary":"Check team permissions for a repository (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou 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/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:","security":[{"bearerAuth":[]}]},"put":{"tags":["Teams"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/repos/{owner}/{repo}"},"summary":"Add or update team repository permissions (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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"]}}},"example":{"permission":""}}}}},"delete":{"tags":["Teams"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/repos/{owner}/{repo}"},"summary":"Remove a repository from a team (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/teams/{team_id}/teams":{"get":{"tags":["Teams"],"parameters":[{"name":"team_id","in":"path","description":"The unique identifier of the team.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#list-child-teams-legacy","api_endpoint":"https://api.github.com/teams/{team_id}/teams"},"summary":"List child teams (Legacy)","description":"> [!WARNING]\n> **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/rest/teams/teams#list-child-teams) endpoint.","security":[{"bearerAuth":[]}]}},"/user":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/users#get-the-authenticated-user","api_endpoint":"https://api.github.com/user"},"summary":"Get the authenticated user","description":"OAuth app tokens and personal access tokens (classic) need the `read:user` scope, or the broader `user` scope, for this endpoint to return the private user response. The private user response includes additional fields such as `private_gists`, `total_private_repos`, `owned_private_repos`, `disk_usage`, `collaborators`, and `two_factor_authentication`. Tokens without these scopes receive the public user response.\n\nThe private and public user response types are unrelated to the [private profile](https://docs.github.com/account-and-profile/concepts/personal-profile#private-profiles) setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as `followers` and `following`, may differ from an unauthenticated response.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/users#update-the-authenticated-user","api_endpoint":"https://api.github.com/user"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"bio":{"type":"string","description":"The new short biography of the user."},"blog":{"type":"string","description":"The new blog URL of the user."},"company":{"type":"string","description":"The new company of the user."},"email":{"type":"string","description":"The publicly visible email address of the user."},"hireable":{"type":"boolean","description":"The new hiring availability of the user.","enum":[true,false]},"location":{"type":"string","description":"The new location of the user."},"name":{"type":"string","description":"The new name of the user."},"twitter_username":{"type":"string","description":"The new Twitter username of the user."}}},"example":{"bio":"","blog":"","company":"","email":"","hireable":"","location":"","name":"","twitter_username":""}}}}}},"/user/blocks":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user","api_endpoint":"https://api.github.com/user/blocks"},"summary":"List users blocked by the authenticated user","description":"List the users you've blocked on your personal account.","security":[{"bearerAuth":[]}]}},"/user/blocks/{username}":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user","api_endpoint":"https://api.github.com/user/blocks/{username}"},"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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/blocking#block-a-user","api_endpoint":"https://api.github.com/user/blocks/{username}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/blocking#unblock-a-user","api_endpoint":"https://api.github.com/user/blocks/{username}"},"summary":"Unblock a user","description":"Unblocks the given user and returns a 204.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/codespaces":{"get":{"tags":["Codespaces"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"repository_id","in":"query","description":"ID of the Repository to filter on","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces"},"summary":"List codespaces for the authenticated user","description":"Lists the authenticated user's codespaces.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Codespaces"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces"},"summary":"Create a codespace for the authenticated user","description":"Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_ip":{"type":"string","description":"IP for location auto-detection when proxying a request"},"devcontainer_path":{"type":"string","description":"Path to devcontainer.json config to use for this codespace"},"display_name":{"type":"string","description":"Display name for this codespace"},"geo":{"type":"string","description":"The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.","enum":["EuropeWest","SoutheastAsia","UsEast","UsWest"]},"idle_timeout_minutes":{"type":"number","description":"Time in minutes before codespace stops from inactivity"},"location":{"type":"string","description":"The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided."},"machine":{"type":"string","description":"Machine type to use for this codespace"},"multi_repo_permissions_opt_out":{"type":"boolean","description":"Whether to authorize requested permissions from devcontainer.json","enum":[true,false]},"ref":{"type":"string","description":"Git ref (typically a branch name) for this codespace"},"repository_id":{"type":"number","description":"Repository id for this codespace","required":true},"retention_period_minutes":{"type":"number","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)."},"working_directory":{"type":"string","description":"Working directory for this codespace"}}},"example":{"client_ip":"","devcontainer_path":"","display_name":"","geo":"","idle_timeout_minutes":"","location":"","machine":"","multi_repo_permissions_opt_out":"","ref":"","repository_id":"","retention_period_minutes":"","working_directory":""}}}}}},"/user/codespaces/secrets":{"get":{"tags":["Codespaces"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/secrets"},"summary":"List secrets for the authenticated user","description":"Lists all development environment secrets available for a user's codespaces without revealing their\nencrypted values.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/user/codespaces/secrets/public-key":{"get":{"tags":["Codespaces"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/secrets/public-key"},"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.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/user/codespaces/secrets/{secret_name}":{"get":{"tags":["Codespaces"],"parameters":[{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/secrets/{secret_name}"},"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.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Codespaces"],"parameters":[{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/secrets/{secret_name}"},"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\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint."},"key_id":{"type":"string","description":"ID of the key you used to encrypt the secret.","required":true},"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/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.","items":{"type":"string"}}}},"example":{"encrypted_value":"","key_id":"","selected_repository_ids":[]}}}}},"delete":{"tags":["Codespaces"],"parameters":[{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/secrets/{secret_name}"},"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.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/codespaces/secrets/{secret_name}/repositories":{"get":{"tags":["Codespaces"],"parameters":[{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret","api_endpoint":"https://api.github.com/user/codespaces/secrets/{secret_name}/repositories"},"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.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Codespaces"],"parameters":[{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret","api_endpoint":"https://api.github.com/user/codespaces/secrets/{secret_name}/repositories"},"summary":"Set selected repositories for a user secret","description":"Select the repositories that will use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"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/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.","required":true,"items":{"type":"number"}}}},"example":{"selected_repository_ids":[]}}}}}},"/user/codespaces/secrets/{secret_name}/repositories/{repository_id}":{"put":{"tags":["Codespaces"],"parameters":[{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret","api_endpoint":"https://api.github.com/user/codespaces/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Add a selected repository to a user secret","description":"Adds a repository to the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Codespaces"],"parameters":[{"name":"repository_id","in":"path","description":"repository_id","required":true,"schema":{"type":"number","example":""}},{"name":"secret_name","in":"path","description":"The name of the secret.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret","api_endpoint":"https://api.github.com/user/codespaces/secrets/{secret_name}/repositories/{repository_id}"},"summary":"Remove a selected repository from a user secret","description":"Removes a repository from the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/codespaces/{codespace_name}":{"get":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}"},"summary":"Get a codespace for the authenticated user","description":"Gets information about a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}"},"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.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"display_name":{"type":"string","description":"Display name for this codespace"},"machine":{"type":"string","description":"A valid machine to transition this codespace to."},"recent_folders":{"type":"array","description":"Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.","items":{"type":"string"}}}},"example":{"display_name":"","machine":"","recent_folders":[]}}}}},"delete":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}"},"summary":"Delete a codespace for the authenticated user","description":"Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/codespaces/{codespace_name}/exports":{"post":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}/exports"},"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.\n\nIf changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/codespaces/{codespace_name}/exports/{export_id}":{"get":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}},{"name":"export_id","in":"path","description":"The ID of the export operation, or `latest`. Currently only `latest` is currently supported.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}/exports/{export_id}"},"summary":"Get details about a codespace export","description":"Gets information about an export of a codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/user/codespaces/{codespace_name}/machines":{"get":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}/machines"},"summary":"List machine types for a codespace","description":"List the machine types a codespace can transition to use.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/user/codespaces/{codespace_name}/publish":{"post":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}/publish"},"summary":"Create a repository from an unpublished codespace","description":"Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A name for the new repository."},"private":{"type":"boolean","description":"Whether the new repository should be private.","enum":[true,false]}}},"example":{"name":"","private":""}}}}}},"/user/codespaces/{codespace_name}/start":{"post":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}/start"},"summary":"Start a codespace for the authenticated user","description":"Starts a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/codespaces/{codespace_name}/stop":{"post":{"tags":["Codespaces"],"parameters":[{"name":"codespace_name","in":"path","description":"The name of the codespace.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/codespaces/{codespace_name}/stop"},"summary":"Stop a codespace for the authenticated user","description":"Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/docker/conflicts":{"get":{"tags":["Packages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user","api_endpoint":"https://api.github.com/user/docker/conflicts"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/user/email/visibility":{"patch":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/email/visibility"},"summary":"Set primary email visibility for the authenticated user","description":"Sets the visibility for your primary email addresses.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"visibility":{"type":"string","description":"Denotes whether an email is publicly visible.","required":true,"enum":["public","private"]}}},"example":{"visibility":""}}}}}},"/user/emails":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/emails"},"summary":"List email addresses for the authenticated user","description":"Lists all of your email addresses, and specifies which one is visible\nto the public.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/emails"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","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.","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}},"delete":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/emails"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"Email addresses associated with the GitHub user account.","required":true,"items":{"type":"string"}}}},"example":{"emails":[]}}}}}},"/user/followers":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user","api_endpoint":"https://api.github.com/user/followers"},"summary":"List followers of the authenticated user","description":"Lists the people following the authenticated user.","security":[{"bearerAuth":[]}]}},"/user/following":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows","api_endpoint":"https://api.github.com/user/following"},"summary":"List the people the authenticated user follows","description":"Lists the people who the authenticated user follows.","security":[{"bearerAuth":[]}]}},"/user/following/{username}":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user","api_endpoint":"https://api.github.com/user/following/{username}"},"summary":"Check if a person is followed by the authenticated user","description":"Check if a person is followed by the authenticated user","security":[{"bearerAuth":[]}]},"put":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/followers#follow-a-user","api_endpoint":"https://api.github.com/user/following/{username}"},"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/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/followers#unfollow-a-user","api_endpoint":"https://api.github.com/user/following/{username}"},"summary":"Unfollow a user","description":"OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/gpg_keys":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/gpg_keys"},"summary":"List GPG keys for the authenticated user","description":"Lists the current user's GPG keys.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/gpg_keys"},"summary":"Create a GPG key for the authenticated user","description":"Adds a GPG key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"armored_public_key":{"type":"string","description":"A GPG key in ASCII-armored format.","required":true},"name":{"type":"string","description":"A descriptive name for the new key."}}},"example":{"armored_public_key":"","name":""}}}}}},"/user/gpg_keys/{gpg_key_id}":{"get":{"tags":["Users"],"parameters":[{"name":"gpg_key_id","in":"path","description":"The unique identifier of the GPG key.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/gpg_keys/{gpg_key_id}"},"summary":"Get a GPG key for the authenticated user","description":"View extended details for a single GPG key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Users"],"parameters":[{"name":"gpg_key_id","in":"path","description":"The unique identifier of the GPG key.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/gpg_keys/{gpg_key_id}"},"summary":"Delete a GPG key for the authenticated user","description":"Removes a GPG key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/installations":{"get":{"tags":["Apps"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token","api_endpoint":"https://api.github.com/user/installations"},"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.\n\nThe 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.\n\nYou can find the permissions for the installation under the `permissions` key.","security":[{"bearerAuth":[]}]}},"/user/installations/{installation_id}/repositories":{"get":{"tags":["Apps"],"parameters":[{"name":"installation_id","in":"path","description":"The unique identifier of the installation.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token","api_endpoint":"https://api.github.com/user/installations/{installation_id}/repositories"},"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.\n\nThe 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.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.","security":[{"bearerAuth":[]}]}},"/user/installations/{installation_id}/repositories/{repository_id}":{"put":{"tags":["Apps"],"parameters":[{"name":"installation_id","in":"path","description":"The unique identifier of the installation.","required":true,"schema":{"type":"number","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation","api_endpoint":"https://api.github.com/user/installations/{installation_id}/repositories/{repository_id}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Apps"],"parameters":[{"name":"installation_id","in":"path","description":"The unique identifier of the installation.","required":true,"schema":{"type":"number","example":""}},{"name":"repository_id","in":"path","description":"The unique identifier of the repository.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation","api_endpoint":"https://api.github.com/user/installations/{installation_id}/repositories/{repository_id}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/interaction-limits":{"get":{"tags":["Interactions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories","api_endpoint":"https://api.github.com/user/interaction-limits"},"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.","security":[{"bearerAuth":[]}]},"put":{"tags":["Interactions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories","api_endpoint":"https://api.github.com/user/interaction-limits"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"expiry":{"type":"string","description":"The duration of the interaction restriction. Default: `one_day`.","enum":["one_day","three_days","one_week","one_month","six_months"]},"limit":{"type":"string","description":"The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.","required":true,"enum":["existing_users","contributors_only","collaborators_only"]}}},"example":{"expiry":"","limit":""}}}}},"delete":{"tags":["Interactions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories","api_endpoint":"https://api.github.com/user/interaction-limits"},"summary":"Remove interaction restrictions from your public repositories","description":"Removes any interaction restrictions from your public repositories.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/issues":{"get":{"tags":["Issues"],"parameters":[{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"filter","in":"query","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.","schema":{"type":"string","example":"","items":{"type":"string","enum":["assigned","created","mentioned","subscribed","repos","all"]}}},{"name":"labels","in":"query","description":"A list of comma separated label names. Example: `bug,ui,@high`","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"What to sort results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","comments"]}}},{"name":"state","in":"query","description":"Indicates the state of the issues to return.","schema":{"type":"string","example":"","items":{"type":"string","enum":["open","closed","all"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user","api_endpoint":"https://api.github.com/user/issues"},"summary":"List user account issues assigned to the authenticated user","description":"List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> 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/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`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.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.","security":[{"bearerAuth":[]}]}},"/user/keys":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/keys"},"summary":"List public SSH keys for the authenticated user","description":"Lists the public SSH keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/keys"},"summary":"Create a public SSH key for the authenticated user","description":"Adds a public SSH key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key":{"type":"string","description":"The public SSH key to add to your GitHub account.","required":true},"title":{"type":"string","description":"A descriptive name for the new key."}}},"example":{"key":"","title":""}}}}}},"/user/keys/{key_id}":{"get":{"tags":["Users"],"parameters":[{"name":"key_id","in":"path","description":"The unique identifier of the key.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/keys/{key_id}"},"summary":"Get a public SSH key for the authenticated user","description":"View extended details for a single public SSH key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Users"],"parameters":[{"name":"key_id","in":"path","description":"The unique identifier of the key.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/keys/{key_id}"},"summary":"Delete a public SSH key for the authenticated user","description":"Removes a public SSH key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/marketplace_purchases":{"get":{"tags":["Apps"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/marketplace_purchases"},"summary":"List subscriptions for the authenticated user","description":"Lists the active subscriptions for the authenticated user.","security":[{"bearerAuth":[]}]}},"/user/marketplace_purchases/stubbed":{"get":{"tags":["Apps"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed","api_endpoint":"https://api.github.com/user/marketplace_purchases/stubbed"},"summary":"List subscriptions for the authenticated user (stubbed)","description":"Lists the active subscriptions for the authenticated user.","security":[{"bearerAuth":[]}]}},"/user/memberships/orgs":{"get":{"tags":["Organizations"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"state","in":"query","description":"Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.","schema":{"type":"string","example":"","items":{"type":"string","enum":["active","pending"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/memberships/orgs"},"summary":"List organization memberships for the authenticated user","description":"Lists all of the authenticated user's organization memberships.","security":[{"bearerAuth":[]}]}},"/user/memberships/orgs/{org}":{"get":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/memberships/orgs/{org}"},"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.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Organizations"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/memberships/orgs/{org}"},"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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"state":{"type":"string","description":"The state that the membership should be in. Only `\"active\"` will be accepted.","required":true,"enum":["active"]}}},"example":{"state":""}}}}}},"/user/migrations":{"get":{"tags":["Migrations"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/users#list-user-migrations","api_endpoint":"https://api.github.com/user/migrations"},"summary":"List user migrations","description":"Lists all migrations a user has started.","security":[{"bearerAuth":[]}]},"post":{"tags":["Migrations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/users#start-a-user-migration","api_endpoint":"https://api.github.com/user/migrations"},"summary":"Start a user migration","description":"Initiates the generation of a user migration archive.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"exclude":{"type":"array","description":"Exclude attributes from the API response to improve performance","items":{"type":"string"}},"exclude_attachments":{"type":"boolean","description":"Do not include attachments in the migration","enum":[true,false]},"exclude_git_data":{"type":"boolean","description":"Indicates whether the repository git data should be excluded from the migration.","enum":[true,false]},"exclude_metadata":{"type":"boolean","description":"Indicates whether metadata should be excluded and only git source should be included for the migration.","enum":[true,false]},"exclude_owner_projects":{"type":"boolean","description":"Indicates whether projects owned by the organization or users should be excluded.","enum":[true,false]},"exclude_releases":{"type":"boolean","description":"Do not include releases in the migration","enum":[true,false]},"lock_repositories":{"type":"boolean","description":"Lock the repositories being migrated at the start of the migration","enum":[true,false]},"org_metadata_only":{"type":"boolean","description":"Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).","enum":[true,false]},"repositories":{"type":"array","description":"repositories","required":true,"items":{"type":"string"}}}},"example":{"exclude":[],"exclude_attachments":"","exclude_git_data":"","exclude_metadata":"","exclude_owner_projects":"","exclude_releases":"","lock_repositories":"","org_metadata_only":"","repositories":[]}}}}}},"/user/migrations/{migration_id}":{"get":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}},{"name":"exclude","in":"query","description":"exclude","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/users#get-a-user-migration-status","api_endpoint":"https://api.github.com/user/migrations/{migration_id}"},"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:\n\n*   `pending` - the migration hasn't started yet.\n*   `exporting` - the migration is in progress.\n*   `exported` - the migration finished successfully.\n*   `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).","security":[{"bearerAuth":[]}]}},"/user/migrations/{migration_id}/archive":{"get":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/users#download-a-user-migration-archive","api_endpoint":"https://api.github.com/user/migrations/{migration_id}/archive"},"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:\n\n*   attachments\n*   bases\n*   commit\\_comments\n*   issue\\_comments\n*   issue\\_events\n*   issues\n*   milestones\n*   organizations\n*   projects\n*   protected\\_branches\n*   pull\\_request\\_reviews\n*   pull\\_requests\n*   releases\n*   repositories\n*   review\\_comments\n*   schema\n*   users\n\nThe 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.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive","api_endpoint":"https://api.github.com/user/migrations/{migration_id}/archive"},"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/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/migrations/{migration_id}/repos/{repo_name}/lock":{"delete":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}},{"name":"repo_name","in":"path","description":"repo_name parameter","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/users#unlock-a-user-repository","api_endpoint":"https://api.github.com/user/migrations/{migration_id}/repos/{repo_name}/lock"},"summary":"Unlock a user repository","description":"Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/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/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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/migrations/{migration_id}/repositories":{"get":{"tags":["Migrations"],"parameters":[{"name":"migration_id","in":"path","description":"The unique identifier of the migration.","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration","api_endpoint":"https://api.github.com/user/migrations/{migration_id}/repositories"},"summary":"List repositories for a user migration","description":"Lists all the repositories for this user migration.","security":[{"bearerAuth":[]}]}},"/user/orgs":{"get":{"tags":["Organizations"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/orgs"},"summary":"List organizations for the authenticated user","description":"List organizations for the authenticated user.\n\nFor 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.\n\n> [!NOTE]\n> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.","security":[{"bearerAuth":[]}]}},"/user/packages":{"get":{"tags":["Packages"],"parameters":[{"name":"package_type","in":"query","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"visibility","in":"query","description":"The selected visibility of the packages.  This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"","schema":{"type":"string","example":"","items":{"type":"string","enum":["public","private","internal"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace","api_endpoint":"https://api.github.com/user/packages"},"summary":"List packages for the authenticated user's namespace","description":"Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]}},"/user/packages/{package_type}/{package_name}":{"get":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/packages/{package_type}/{package_name}"},"summary":"Get a package for the authenticated user","description":"Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]},"delete":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/packages/{package_type}/{package_name}"},"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.\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/packages/{package_type}/{package_name}/restore":{"post":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"token","in":"query","description":"package token","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/packages/{package_type}/{package_name}/restore"},"summary":"Restore a package for the authenticated user","description":"Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n  - The package was deleted within the last 30 days.\n  - 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.\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/packages/{package_type}/{package_name}/versions":{"get":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"state","in":"query","description":"The state of the package, either active or deleted.","schema":{"type":"string","example":"","items":{"type":"string","enum":["active","deleted"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user","api_endpoint":"https://api.github.com/user/packages/{package_type}/{package_name}/versions"},"summary":"List package versions for a package owned by the authenticated user","description":"Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]}},"/user/packages/{package_type}/{package_name}/versions/{package_version_id}":{"get":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/packages/{package_type}/{package_name}/versions/{package_version_id}"},"summary":"Get a package version for the authenticated user","description":"Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]},"delete":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/packages/{package_type}/{package_name}/versions/{package_version_id}"},"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.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore":{"post":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"},"summary":"Restore a package version for the authenticated user","description":"Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n  - The package was deleted within the last 30 days.\n  - 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.\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/public_emails":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/public_emails"},"summary":"List public email addresses for the authenticated user","description":"Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/user/repos":{"get":{"tags":["Repos"],"parameters":[{"name":"type","in":"query","description":"Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","owner","public","private","member"]}}},{"name":"affiliation","in":"query","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.","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.","schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","description":"Only show repositories 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`.","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","pushed","full_name"]}}},{"name":"visibility","in":"query","description":"Limit results to repositories with the specified visibility.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","public","private"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/repos"},"summary":"List repositories for the authenticated user","description":"Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe 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.","security":[{"bearerAuth":[]}]},"post":{"tags":["Repos"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/repos"},"summary":"Create a repository for the authenticated user","description":"Creates a new repository for the authenticated user.\n\nOAuth 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.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_auto_merge":{"type":"boolean","description":"Whether to allow Auto-merge to be used on pull requests.","enum":[true,false]},"allow_merge_commit":{"type":"boolean","description":"Whether to allow merge commits for pull requests.","enum":[true,false]},"allow_rebase_merge":{"type":"boolean","description":"Whether to allow rebase merges for pull requests.","enum":[true,false]},"allow_squash_merge":{"type":"boolean","description":"Whether to allow squash merges for pull requests.","enum":[true,false]},"auto_init":{"type":"boolean","description":"Whether the repository is initialized with a minimal README.","enum":[true,false]},"delete_branch_on_merge":{"type":"boolean","description":"Whether to delete head branches when pull requests are merged","enum":[true,false]},"description":{"type":"string","description":"A short description of the repository."},"gitignore_template":{"type":"string","description":"The desired language or platform to apply to the .gitignore."},"has_discussions":{"type":"boolean","description":"Whether discussions are enabled.","enum":[true,false]},"has_downloads":{"type":"boolean","description":"Whether downloads are enabled.","enum":[true,false]},"has_issues":{"type":"boolean","description":"Whether issues are enabled.","enum":[true,false]},"has_projects":{"type":"boolean","description":"Whether projects are enabled.","enum":[true,false]},"has_wiki":{"type":"boolean","description":"Whether the wiki is enabled.","enum":[true,false]},"homepage":{"type":"string","description":"A URL with more information about the repository."},"is_template":{"type":"boolean","description":"Whether this repository acts as a template that can be used to generate new repositories.","enum":[true,false]},"license_template":{"type":"string","description":"The license keyword of the open source license for this repository."},"merge_commit_message":{"type":"string","description":"The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.","enum":["PR_BODY","PR_TITLE","BLANK"]},"merge_commit_title":{"type":"string","description":"Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).","enum":["PR_TITLE","MERGE_MESSAGE"]},"name":{"type":"string","description":"The name of the repository.","required":true},"private":{"type":"boolean","description":"Whether the repository is private.","enum":[true,false]},"squash_merge_commit_message":{"type":"string","description":"The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.","enum":["PR_BODY","COMMIT_MESSAGES","BLANK"]},"squash_merge_commit_title":{"type":"string","description":"Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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).","enum":["PR_TITLE","COMMIT_OR_PR_TITLE"]},"team_id":{"type":"number","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."}}},"example":{"allow_auto_merge":"","allow_merge_commit":"","allow_rebase_merge":"","allow_squash_merge":"","auto_init":"","delete_branch_on_merge":"","description":"","gitignore_template":"","has_discussions":"","has_downloads":"","has_issues":"","has_projects":"","has_wiki":"","homepage":"","is_template":"","license_template":"","merge_commit_message":"","merge_commit_title":"","name":"","private":"","squash_merge_commit_message":"","squash_merge_commit_title":"","team_id":""}}}}}},"/user/repository_invitations":{"get":{"tags":["Repos"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/repository_invitations"},"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.","security":[{"bearerAuth":[]}]}},"/user/repository_invitations/{invitation_id}":{"patch":{"tags":["Repos"],"parameters":[{"name":"invitation_id","in":"path","description":"The unique identifier of the invitation.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation","api_endpoint":"https://api.github.com/user/repository_invitations/{invitation_id}"},"summary":"Accept a repository invitation","description":"Accept a repository invitation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Repos"],"parameters":[{"name":"invitation_id","in":"path","description":"The unique identifier of the invitation.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation","api_endpoint":"https://api.github.com/user/repository_invitations/{invitation_id}"},"summary":"Decline a repository invitation","description":"Decline a repository invitation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/social_accounts":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/social_accounts"},"summary":"List social accounts for the authenticated user","description":"Lists all of your social accounts.","security":[{"bearerAuth":[]}]},"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/social_accounts"},"summary":"Add social accounts for the authenticated user","description":"Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"account_urls":{"type":"array","description":"Full URLs for the social media profiles to add.","required":true,"items":{"type":"string"}}}},"example":{"account_urls":[]}}}}},"delete":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/social_accounts"},"summary":"Delete social accounts for the authenticated user","description":"Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"account_urls":{"type":"array","description":"Full URLs for the social media profiles to delete.","required":true,"items":{"type":"string"}}}},"example":{"account_urls":[]}}}}}},"/user/ssh_signing_keys":{"get":{"tags":["Users"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/ssh_signing_keys"},"summary":"List SSH signing keys for the authenticated user","description":"Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/ssh_signing_keys"},"summary":"Create a SSH signing key for the authenticated user","description":"Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key":{"type":"string","description":"The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"","required":true},"title":{"type":"string","description":"A descriptive name for the new key."}}},"example":{"key":"","title":""}}}}}},"/user/ssh_signing_keys/{ssh_signing_key_id}":{"get":{"tags":["Users"],"parameters":[{"name":"ssh_signing_key_id","in":"path","description":"The unique identifier of the SSH signing key.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/ssh_signing_keys/{ssh_signing_key_id}"},"summary":"Get an SSH signing key for the authenticated user","description":"Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"delete":{"tags":["Users"],"parameters":[{"name":"ssh_signing_key_id","in":"path","description":"The unique identifier of the SSH signing key.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/ssh_signing_keys/{ssh_signing_key_id}"},"summary":"Delete an SSH signing key for the authenticated user","description":"Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/starred":{"get":{"tags":["Activity"],"parameters":[{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user","api_endpoint":"https://api.github.com/user/starred"},"summary":"List repositories starred by the authenticated user","description":"Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.","security":[{"bearerAuth":[]}]}},"/user/starred/{owner}/{repo}":{"get":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user","api_endpoint":"https://api.github.com/user/starred/{owner}/{repo}"},"summary":"Check if a repository is starred by the authenticated user","description":"Whether the authenticated user has starred the repository.","security":[{"bearerAuth":[]}]},"put":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/starred/{owner}/{repo}"},"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/rest/guides/getting-started-with-the-rest-api#http-method).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Activity"],"parameters":[{"name":"owner","in":"path","description":"The account owner of the repository. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"The name of the repository without the `.git` extension. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/starred/{owner}/{repo}"},"summary":"Unstar a repository for the authenticated user","description":"Unstar a repository that the authenticated user has previously starred.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/user/subscriptions":{"get":{"tags":["Activity"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user","api_endpoint":"https://api.github.com/user/subscriptions"},"summary":"List repositories watched by the authenticated user","description":"Lists repositories the authenticated user is watching.","security":[{"bearerAuth":[]}]}},"/user/teams":{"get":{"tags":["Teams"],"parameters":[{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user","api_endpoint":"https://api.github.com/user/teams"},"summary":"List teams for the authenticated user","description":"List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen 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.","security":[{"bearerAuth":[]}]}},"/user/{account_id}":{"get":{"tags":["Users"],"parameters":[{"name":"account_id","in":"path","description":"account_id parameter","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/users#get-a-user-using-their-id","api_endpoint":"https://api.github.com/user/{account_id}"},"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.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/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.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [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. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe 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/rest/users/emails).","security":[{"bearerAuth":[]}]}},"/user/{user_id}/projectsV2/{project_number}/drafts":{"post":{"tags":["Projects"],"parameters":[{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"user_id","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project","api_endpoint":"https://api.github.com/user/{user_id}/projectsV2/{project_number}/drafts"},"summary":"Create draft item for user owned project","description":"Create draft issue item for the specified user owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"The body content of the draft issue item to create in the project."},"title":{"type":"string","description":"The title of the draft issue item to create in the project.","required":true}}},"example":{"body":"","title":""}}}}}},"/users":{"get":{"tags":["Users"],"parameters":[{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","description":"A user ID. Only return users with an ID greater than this ID.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/users#list-users","api_endpoint":"https://api.github.com/users"},"summary":"List users","description":"Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.","security":[{"bearerAuth":[]}]}},"/users/{user_id}/projectsV2/{project_number}/views":{"post":{"tags":["Projects"],"parameters":[{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"user_id","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project","api_endpoint":"https://api.github.com/users/{user_id}/projectsV2/{project_number}/views"},"summary":"Create a view for a user-owned project","description":"Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"filter":{"type":"string","description":"The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information."},"group_by":{"type":"array","description":"The field IDs to group items by (horizontal grouping). Supports a single field. The field must support grouping; fields such as `Title`, `Reviewers`, `Linked pull requests`, `Sub-issues progress`, `Tracked by`, and `Tracks` cannot be grouped on.","items":{"type":"number"}},"layout":{"type":"string","description":"The layout of the view.","required":true,"enum":["table","board","roadmap"]},"name":{"type":"string","description":"The name of the view.","required":true},"sort_by":{"type":"array","description":"Sorting configuration for the view. Each element is a two-element array of `[field_id, direction]` where `direction` is `\"asc\"` or `\"desc\"`. Supports multiple sort criteria applied in order.","items":{"type":"array"}},"vertical_group_by":{"type":"array","description":"The field IDs to use as columns in `board` layout (vertical grouping). Supports a single field. The field must support grouping; fields such as `Title`, `Reviewers`, `Linked pull requests`, `Sub-issues progress`, `Tracked by`, and `Tracks` cannot be grouped on.","items":{"type":"number"}},"visible_fields":{"type":"array","description":"`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.","items":{"type":"number"}}}},"example":{"filter":"","group_by":[],"layout":"","name":"","sort_by":[],"vertical_group_by":[],"visible_fields":[]}}}}}},"/users/{username}":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/users#get-a-user","api_endpoint":"https://api.github.com/users/{username}"},"summary":"Get a user","description":"Provides publicly available information about someone with a GitHub account.\n\nIf the specified user has a [private profile](https://docs.github.com/account-and-profile/concepts/personal-profile#private-profiles), the `followers` and `following` values are `0` unless the request is authenticated as that user. A request authenticated as the specified user returns the actual values even if the token has no OAuth scopes.\n\nThe `events_url` value is a URI template. Replace `{/privacy}` with `/public` to retrieve only public events. Omit it to retrieve public events and, when authenticated as the user, private events. For more information, see \"[List events for the authenticated user](https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user).\"\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/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.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [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. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe 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/rest/users/emails).","security":[{"bearerAuth":[]}]}},"/users/{username}/attestations/bulk-list":{"post":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests","api_endpoint":"https://api.github.com/users/{username}/attestations/bulk-list"},"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.\n\nThe 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.\n\n**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/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"predicate_type":{"type":"string","description":"Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types."},"subject_digests":{"type":"array","description":"List of subject digests to fetch attestations for.","required":true,"items":{"type":"string"}}}},"example":{"predicate_type":"","subject_digests":[]}}}}}},"/users/{username}/attestations/delete-request":{"post":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk","api_endpoint":"https://api.github.com/users/{username}/attestations/delete-request"},"summary":"Delete attestations in bulk","description":"Delete artifact attestations in bulk by either subject digests or unique ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subject_digests":{"type":"array","description":"List of subject digests associated with the artifact attestations to delete.","required":true,"items":{"type":"string"}}}},"example":{"subject_digests":[]}}}}}},"/users/{username}/attestations/digest/{subject_digest}":{"delete":{"tags":["Users"],"parameters":[{"name":"subject_digest","in":"path","description":"Subject Digest","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest","api_endpoint":"https://api.github.com/users/{username}/attestations/digest/{subject_digest}"},"summary":"Delete attestations by subject digest","description":"Delete an artifact attestation by subject digest.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/attestations/{attestation_id}":{"delete":{"tags":["Users"],"parameters":[{"name":"attestation_id","in":"path","description":"Attestation ID","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/attestations#delete-attestations-by-id","api_endpoint":"https://api.github.com/users/{username}/attestations/{attestation_id}"},"summary":"Delete attestations by ID","description":"Delete an artifact attestation by unique ID that is associated with a repository owned by a user.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/attestations/{subject_digest}":{"get":{"tags":["Users"],"parameters":[{"name":"subject_digest","in":"path","description":"Subject Digest","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"predicate_type","in":"query","description":"Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/attestations#list-attestations","api_endpoint":"https://api.github.com/users/{username}/attestations/{subject_digest}"},"summary":"List attestations","description":"List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe 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.\n\n**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/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).","security":[{"bearerAuth":[]}]}},"/users/{username}/copilot-spaces":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.","schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"The number of results per page (max 100).","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#list-copilot-spaces-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces"},"summary":"List Copilot Spaces for a user","description":"Lists Copilot Spaces owned by a user. The authenticated user must have read access to the user's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes the user's own spaces, and public user spaces when accessing another user's spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Copilot Spaces"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#create-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces"},"summary":"Create a Copilot Space for a user","description":"Creates a new Copilot Space owned by a user. Only the authenticated user can create spaces for their own account.\n\nUsers can create personal Copilot Spaces for their individual use.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"base_role":{"type":"string","description":"The base role that determines default permissions for the space.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.","enum":["reader","no_access"]},"description":{"type":"string","description":"A description of the Copilot Space."},"general_instructions":{"type":"string","description":"General instructions for the Copilot Space."},"name":{"type":"string","description":"The name of the Copilot Space.","required":true},"resources_attributes":{"type":"array","description":"Resources to attach to the space.","items":{"type":"object","properties":{"metadata":{"type":"object","description":"Metadata specific to the resource type."},"resource_type":{"type":"string","description":"The type of resource.","enum":["repository","github_file","free_text","github_issue","github_pull_request","media_content","uploaded_text_file"]}}}}}},"example":{"base_role":"","description":"","general_instructions":"","name":"","resources_attributes":[]}}}}}},"/users/{username}/copilot-spaces/{space_number}":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#get-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}"},"summary":"Get a Copilot Space for a user","description":"Gets details about a specific Copilot Space owned by a user. The authenticated user must have read access to the Space.\n\nPrivate user spaces require the authenticated user to be the owner of the space.\nPublic user spaces are accessible to any authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#set-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}"},"summary":"Set a Copilot Space for a user","description":"Updates a Copilot Space owned by a user. Only the authenticated user can update spaces for their own account.\n\nUsers can update their personal Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"base_role":{"type":"string","description":"The base role that determines default permissions for the space. Changing this field requires admin permissions.\n- `no_access`: No default access (default)\n- `reader`: Makes the space publicly readable\nNote: User spaces do not support writer or admin base roles.","enum":["reader","no_access"]},"description":{"type":"string","description":"A description of the Copilot Space."},"general_instructions":{"type":"string","description":"General instructions for the Copilot Space."},"name":{"type":"string","description":"The name of the Copilot Space."},"resources_attributes":{"type":"array","description":"Resources to attach to the space.","items":{"type":"object","properties":{"metadata":{"type":"object","description":"Metadata specific to the resource type."},"resource_type":{"type":"string","description":"The type of resource.","enum":["repository","github_file","free_text","github_issue","github_pull_request","media_content","uploaded_text_file"]}}}}}},"example":{"base_role":"","description":"","general_instructions":"","name":"","resources_attributes":[]}}}}},"delete":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/copilot-spaces#delete-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}"},"summary":"Delete a Copilot Space for a user","description":"Deletes a Copilot Space owned by a user. The authenticated user must be the owner of the space.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a space will remove all associated resources and configurations.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/copilot-spaces/{space_number}/collaborators":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/collaborators#list-collaborators-for-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/collaborators"},"summary":"List collaborators for a Copilot Space for a user","description":"Lists all collaborators for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nEach collaborator entry specifies which user has access to the space and at what level (reader, writer, or admin). The space owner is excluded from this list.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/collaborators#add-a-collaborator-to-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/collaborators"},"summary":"Add a collaborator to a Copilot Space for a user","description":"Adds a collaborator to a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nTeam collaborators are not supported for user-owned Copilot Spaces.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"actor_identifier":{"type":"string","description":"The username of the collaborator. The numeric user ID is also accepted.","required":true},"actor_type":{"type":"string","description":"The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).","required":true,"enum":["User","Team"]},"role":{"type":"string","description":"The role to grant to the collaborator.","required":true,"enum":["reader","writer","admin"]}}},"example":{"actor_identifier":"","actor_type":"","role":""}}}}}},"/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}":{"put":{"tags":["Copilot Spaces"],"parameters":[{"name":"actor_identifier","in":"path","description":"The username of the collaborator. The numeric user ID is also accepted.","required":true,"schema":{"type":"string","example":""}},{"name":"actor_type","in":"path","description":"The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["User","Team"]}}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/collaborators#set-a-collaborator-role-for-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}"},"summary":"Set a collaborator role for a Copilot Space for a user","description":"Updates the role of a collaborator for a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"role":{"type":"string","description":"The new role to grant to the collaborator. Use `no_access` to remove the collaborator.","required":true,"enum":["reader","writer","admin","no_access"]}}},"example":{"role":""}}}}},"delete":{"tags":["Copilot Spaces"],"parameters":[{"name":"actor_identifier","in":"path","description":"The username of the collaborator. The numeric user ID is also accepted.","required":true,"schema":{"type":"string","example":""}},{"name":"actor_type","in":"path","description":"The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["User","Team"]}}},{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/collaborators#remove-a-collaborator-from-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}"},"summary":"Remove a collaborator from a Copilot Space for a user","description":"Removes a collaborator from a specific Copilot Space owned by a user. The authenticated user must be the owner of the space or have admin access to the space.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/copilot-spaces/{space_number}/resources":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#list-resources-for-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/resources"},"summary":"List resources for a Copilot Space for a user","description":"Lists all resources attached to a specific Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"post":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#create-a-resource-for-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/resources"},"summary":"Create a resource for a Copilot Space for a user","description":"Creates a new resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"metadata":{"type":"object","description":"Resource-specific metadata.","required":true,"properties":{}},"resource_type":{"type":"string","description":"The type of resource to create.","required":true,"enum":["repository","github_file","free_text","github_issue","github_pull_request"]}}},"example":{"metadata":{},"resource_type":""}}}}}},"/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}":{"get":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"space_resource_id","in":"path","description":"The unique identifier of the resource.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#get-a-resource-for-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}"},"summary":"Get a resource for a Copilot Space for a user","description":"Gets a specific resource attached to a Copilot Space owned by a user.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:user` scope to use this endpoint.","security":[{"bearerAuth":[]}]},"put":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"space_resource_id","in":"path","description":"The unique identifier of the resource.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#set-a-resource-for-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}"},"summary":"Set a resource for a Copilot Space for a user","description":"Updates the metadata of a resource in a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"metadata":{"type":"object","description":"Updated resource-specific metadata.","properties":{}}}},"example":{"metadata":{}}}}}},"delete":{"tags":["Copilot Spaces"],"parameters":[{"name":"space_number","in":"path","description":"The unique identifier of the Copilot Space.","required":true,"schema":{"type":"number","example":""}},{"name":"space_resource_id","in":"path","description":"The unique identifier of the resource.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/copilot-spaces/resources#delete-a-resource-from-a-copilot-space-for-a-user","api_endpoint":"https://api.github.com/users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}"},"summary":"Delete a resource from a Copilot Space for a user","description":"Deletes a resource from a specific Copilot Space owned by a user.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:user` scope to use this endpoint.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/docker/conflicts":{"get":{"tags":["Packages"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user","api_endpoint":"https://api.github.com/users/{username}/docker/conflicts"},"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.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/users/{username}/events":{"get":{"tags":["Activity"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user","api_endpoint":"https://api.github.com/users/{username}/events"},"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).\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/users/{username}/events/orgs/{org}":{"get":{"tags":["Activity"],"parameters":[{"name":"org","in":"path","description":"The organization name. The name is not case sensitive.","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user","api_endpoint":"https://api.github.com/users/{username}/events/orgs/{org}"},"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.\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/users/{username}/events/public":{"get":{"tags":["Activity"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-public-events-for-a-user","api_endpoint":"https://api.github.com/users/{username}/events/public"},"summary":"List public events for a user","description":"> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/users/{username}/followers":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/followers#list-followers-of-a-user","api_endpoint":"https://api.github.com/users/{username}/followers"},"summary":"List followers of a user","description":"Lists the people following the specified user.\n\nIf the specified user has a [private profile](https://docs.github.com/account-and-profile/concepts/personal-profile#private-profiles), this endpoint returns an empty list unless the request is authenticated as that user. A request authenticated as the specified user returns the list even if the token has no OAuth scopes.","security":[{"bearerAuth":[]}]}},"/users/{username}/following":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/followers#list-the-people-a-user-follows","api_endpoint":"https://api.github.com/users/{username}/following"},"summary":"List the people a user follows","description":"Lists the people who the specified user follows.\n\nIf the specified user has a [private profile](https://docs.github.com/account-and-profile/concepts/personal-profile#private-profiles), this endpoint returns an empty list unless the request is authenticated as that user. A request authenticated as the specified user returns the list even if the token has no OAuth scopes.","security":[{"bearerAuth":[]}]}},"/users/{username}/following/{target_user}":{"get":{"tags":["Users"],"parameters":[{"name":"target_user","in":"path","description":"target_user","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user","api_endpoint":"https://api.github.com/users/{username}/following/{target_user}"},"summary":"Check if a user follows another user","description":"Check if a user follows another user","security":[{"bearerAuth":[]}]}},"/users/{username}/gists":{"get":{"tags":["Gists"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"since","in":"query","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`.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/gists/gists#list-gists-for-a-user","api_endpoint":"https://api.github.com/users/{username}/gists"},"summary":"List gists for a user","description":"Lists public gists for the specified user:","security":[{"bearerAuth":[]}]}},"/users/{username}/gpg_keys":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user","api_endpoint":"https://api.github.com/users/{username}/gpg_keys"},"summary":"List GPG keys for a user","description":"Lists the GPG keys for a user. This information is accessible by anyone.","security":[{"bearerAuth":[]}]}},"/users/{username}/hovercard":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"subject_id","in":"query","description":"Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.","schema":{"type":"string","example":""}},{"name":"subject_type","in":"query","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`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["organization","repository","issue","pull_request"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/users#get-contextual-information-for-a-user","api_endpoint":"https://api.github.com/users/{username}/hovercard"},"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.\n\n  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).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.","security":[{"bearerAuth":[]}]}},"/users/{username}/installation":{"get":{"tags":["Apps"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app","api_endpoint":"https://api.github.com/users/{username}/installation"},"summary":"Get a user installation for the authenticated app","description":"Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","security":[{"bearerAuth":[]}]}},"/users/{username}/keys":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/keys#list-public-keys-for-a-user","api_endpoint":"https://api.github.com/users/{username}/keys"},"summary":"List public keys for a user","description":"Lists the _verified_ public SSH keys for a user. This is accessible by anyone.","security":[{"bearerAuth":[]}]}},"/users/{username}/orgs":{"get":{"tags":["Organizations"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user","api_endpoint":"https://api.github.com/users/{username}/orgs"},"summary":"List organizations for a user","description":"List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis 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/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.","security":[{"bearerAuth":[]}]}},"/users/{username}/packages":{"get":{"tags":["Packages"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"query","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"visibility","in":"query","description":"The selected visibility of the packages.  This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"","schema":{"type":"string","example":"","items":{"type":"string","enum":["public","private","internal"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#list-packages-for-a-user","api_endpoint":"https://api.github.com/users/{username}/packages"},"summary":"List packages for a user","description":"Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]}},"/users/{username}/packages/{package_type}/{package_name}":{"get":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-a-package-for-a-user","api_endpoint":"https://api.github.com/users/{username}/packages/{package_type}/{package_name}"},"summary":"Get a package for a user","description":"Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]},"delete":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user","api_endpoint":"https://api.github.com/users/{username}/packages/{package_type}/{package_name}"},"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.\n\nIf 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/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/packages/{package_type}/{package_name}/restore":{"post":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"token","in":"query","description":"package token","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user","api_endpoint":"https://api.github.com/users/{username}/packages/{package_type}/{package_name}/restore"},"summary":"Restore a package for a user","description":"Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n  - The package was deleted within the last 30 days.\n  - 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.\n\nIf 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/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/packages/{package_type}/{package_name}/versions":{"get":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user","api_endpoint":"https://api.github.com/users/{username}/packages/{package_type}/{package_name}/versions"},"summary":"List package versions for a package owned by a user","description":"Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]}},"/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}":{"get":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user","api_endpoint":"https://api.github.com/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"},"summary":"Get a package version for a user","description":"Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}]},"delete":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user","api_endpoint":"https://api.github.com/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"},"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.\n\nIf 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/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore":{"post":{"tags":["Packages"],"parameters":[{"name":"package_name","in":"path","description":"The name of the package.","required":true,"schema":{"type":"string","example":""}},{"name":"package_type","in":"path","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.","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["npm","maven","rubygems","docker","nuget","container"]}}},{"name":"package_version_id","in":"path","description":"Unique identifier of the package version.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user","api_endpoint":"https://api.github.com/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"},"summary":"Restore package version for a user","description":"Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n  - The package was deleted within the last 30 days.\n  - 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.\n\nIf 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/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth 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/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/projectsV2":{"get":{"tags":["Projects"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"Limit results to projects of the specified type.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/projects#list-projects-for-user","api_endpoint":"https://api.github.com/users/{username}/projectsV2"},"summary":"List projects for user","description":"List all projects owned by a specific user accessible by the authenticated user.","security":[{"bearerAuth":[]}]}},"/users/{username}/projectsV2/{project_number}":{"get":{"tags":["Projects"],"parameters":[{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/projects#get-project-for-user","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}"},"summary":"Get project for user","description":"Get a specific user-owned project.","security":[{"bearerAuth":[]}]}},"/users/{username}/projectsV2/{project_number}/fields":{"get":{"tags":["Projects"],"parameters":[{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/fields#list-project-fields-for-user","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/fields"},"summary":"List project fields for user","description":"List all fields for a specific user-owned project.","security":[{"bearerAuth":[]}]},"post":{"tags":["Projects"],"parameters":[{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/fields"},"summary":"Add field to user owned project","description":"Add a field to a specified user owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data_type":{"type":"string","description":"The field's data type.","required":true,"enum":["text","number","date"]},"name":{"type":"string","description":"The name of the field.","required":true}}},"example":{"data_type":"","name":""}}}}}},"/users/{username}/projectsV2/{project_number}/fields/{field_id}":{"get":{"tags":["Projects"],"parameters":[{"name":"field_id","in":"path","description":"The unique identifier of the field.","required":true,"schema":{"type":"number","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/fields#get-project-field-for-user","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/fields/{field_id}"},"summary":"Get project field for user","description":"Get a specific field for a user-owned project.","security":[{"bearerAuth":[]}]}},"/users/{username}/projectsV2/{project_number}/items":{"get":{"tags":["Projects"],"parameters":[{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/items"},"summary":"List items for a user owned project","description":"List all items for a specific user-owned project accessible by the authenticated user.","security":[{"bearerAuth":[]}]},"post":{"tags":["Projects"],"parameters":[{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#add-item-to-user-owned-project","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/items"},"summary":"Add item to user owned project","description":"Add an issue or pull request item to the specified user owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"The type of item to add to the project. Must be either Issue or PullRequest.","required":true,"enum":["Issue","PullRequest"]},"id":{"type":"number","description":"The unique identifier of the issue or pull request to add to the project."},"number":{"type":"number","description":"The issue or pull request number."},"owner":{"type":"string","description":"The repository owner login."},"repo":{"type":"string","description":"The repository name."}}},"example":{"type":"","id":"","number":"","owner":"","repo":""}}}}}},"/users/{username}/projectsV2/{project_number}/items/{item_id}":{"get":{"tags":["Projects"],"parameters":[{"name":"item_id","in":"path","description":"The unique identifier of the project item.","required":true,"schema":{"type":"number","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/items/{item_id}"},"summary":"Get an item for a user owned project","description":"Get a specific item from a user-owned project.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Projects"],"parameters":[{"name":"item_id","in":"path","description":"The unique identifier of the project item.","required":true,"schema":{"type":"number","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#update-project-item-for-user","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/items/{item_id}"},"summary":"Update project item for user","description":"Update a specific item in a user-owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"array","description":"A list of field updates to apply.","required":true,"items":{"type":"object","properties":{"id":{"type":"number","description":"The ID of the project field to update.","required":true},"value":{"type":"string","description":"The new value for the field:\n- For text, number, and date fields, provide the new value directly.\n- For single select and iteration fields, provide the ID of the option or iteration.\n- To clear the field, set this to null.","required":true}}}}}},"example":{"fields":[]}}}}},"delete":{"tags":["Projects"],"parameters":[{"name":"item_id","in":"path","description":"The unique identifier of the project item.","required":true,"schema":{"type":"number","example":""}},{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#delete-project-item-for-user","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/items/{item_id}"},"summary":"Delete project item for user","description":"Delete a specific item from a user-owned project.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/users/{username}/projectsV2/{project_number}/views/{view_number}/items":{"get":{"tags":["Projects"],"parameters":[{"name":"project_number","in":"path","description":"The project's number.","required":true,"schema":{"type":"number","example":""}},{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"view_number","in":"path","description":"The number that identifies the project view.","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Limit results to specific fields, by their IDs. If not specified, the\ntitle field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`","schema":{"type":"string","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view","api_endpoint":"https://api.github.com/users/{username}/projectsV2/{project_number}/views/{view_number}/items"},"summary":"List items for a user project view","description":"List items in a user project with the saved view's filter applied.","security":[{"bearerAuth":[]}]}},"/users/{username}/received_events":{"get":{"tags":["Activity"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user","api_endpoint":"https://api.github.com/users/{username}/received_events"},"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\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/users/{username}/received_events/public":{"get":{"tags":["Activity"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user","api_endpoint":"https://api.github.com/users/{username}/received_events/public"},"summary":"List public events received by a user","description":"> [!NOTE]\n> 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.","security":[{"bearerAuth":[]}]}},"/users/{username}/repos":{"get":{"tags":["Repos"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"Limit results to repositories of the specified type.","schema":{"type":"string","example":"","items":{"type":"string","enum":["all","owner","member"]}}},{"name":"direction","in":"query","description":"The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated","pushed","full_name"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/repos/repos#list-repositories-for-a-user","api_endpoint":"https://api.github.com/users/{username}/repos"},"summary":"List repositories for a user","description":"Lists public repositories for the specified user.","security":[{"bearerAuth":[]}]}},"/users/{username}/settings/billing/ai_credit/usage":{"get":{"tags":["Billing"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.","schema":{"type":"number","example":""}},{"name":"model","in":"query","description":"The model name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"month","in":"query","description":"If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.","schema":{"type":"number","example":""}},{"name":"product","in":"query","description":"The product name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"year","in":"query","description":"If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/usage#get-billing-ai-credit-usage-report-for-a-user","api_endpoint":"https://api.github.com/users/{username}/settings/billing/ai_credit/usage"},"summary":"Get billing AI credit usage report for a user","description":"Gets a report of AI credit usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.","security":[{"bearerAuth":[]}]}},"/users/{username}/settings/billing/premium_request/usage":{"get":{"tags":["Billing"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.","schema":{"type":"number","example":""}},{"name":"model","in":"query","description":"The model name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"month","in":"query","description":"If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.","schema":{"type":"number","example":""}},{"name":"product","in":"query","description":"The product name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"year","in":"query","description":"If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user","api_endpoint":"https://api.github.com/users/{username}/settings/billing/premium_request/usage"},"summary":"Get billing premium request usage report for a user","description":"Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.","security":[{"bearerAuth":[]}]}},"/users/{username}/settings/billing/usage":{"get":{"tags":["Billing"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.","schema":{"type":"number","example":""}},{"name":"month","in":"query","description":"If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.","schema":{"type":"number","example":""}},{"name":"year","in":"query","description":"If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user","api_endpoint":"https://api.github.com/users/{username}/settings/billing/usage"},"summary":"Get billing usage report for a user","description":"Gets a report of the total usage for a user.\n\n**Note:** This endpoint is only available to users with access to the enhanced billing platform.","security":[{"bearerAuth":[]}]}},"/users/{username}/settings/billing/usage/summary":{"get":{"tags":["Billing"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"day","in":"query","description":"If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.","schema":{"type":"number","example":""}},{"name":"month","in":"query","description":"If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.","schema":{"type":"number","example":""}},{"name":"product","in":"query","description":"The product name to query usage for. The name is not case sensitive.","schema":{"type":"string","example":""}},{"name":"repository","in":"query","description":"The repository name to query for usage in the format owner/repository.","schema":{"type":"string","example":""}},{"name":"sku","in":"query","description":"The SKU to query for usage.","schema":{"type":"string","example":""}},{"name":"year","in":"query","description":"If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user","api_endpoint":"https://api.github.com/users/{username}/settings/billing/usage/summary"},"summary":"Get billing usage summary for a user","description":"> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.","security":[{"bearerAuth":[]}]}},"/users/{username}/social_accounts":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user","api_endpoint":"https://api.github.com/users/{username}/social_accounts"},"summary":"List social accounts for a user","description":"Lists social media accounts for a user. This endpoint is accessible by anyone.","security":[{"bearerAuth":[]}]}},"/users/{username}/ssh_signing_keys":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user","api_endpoint":"https://api.github.com/users/{username}/ssh_signing_keys"},"summary":"List SSH signing keys for a user","description":"Lists the SSH signing keys for a user. This operation is accessible by anyone.","security":[{"bearerAuth":[]}]}},"/users/{username}/starred":{"get":{"tags":["Activity"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"The direction to sort the results by.","schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.","schema":{"type":"string","example":"","items":{"type":"string","enum":["created","updated"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user","api_endpoint":"https://api.github.com/users/{username}/starred"},"summary":"List repositories starred by a user","description":"Lists repositories a user has starred.\n\nIf the specified user has a [private profile](https://docs.github.com/account-and-profile/concepts/personal-profile#private-profiles), this endpoint returns an empty list unless the request is authenticated as that user. A request authenticated as the specified user returns starred repositories visible to the token even if the token has no OAuth scopes.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.","security":[{"bearerAuth":[]}]}},"/users/{username}/subscriptions":{"get":{"tags":["Activity"],"parameters":[{"name":"username","in":"path","description":"The handle for the GitHub user account.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}},{"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/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user","api_endpoint":"https://api.github.com/users/{username}/subscriptions"},"summary":"List repositories watched by a user","description":"Lists repositories a user is watching.","security":[{"bearerAuth":[]}]}},"/versions":{"get":{"tags":["Meta"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/meta/meta#get-all-api-versions","api_endpoint":"https://api.github.com/versions"},"summary":"Get all API versions","description":"Get all supported GitHub API versions.","security":[{"bearerAuth":[]}]}},"/zen":{"get":{"tags":["Meta"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.github.com/rest/meta/meta#get-the-zen-of-github","api_endpoint":"https://api.github.com/zen"},"summary":"Get the Zen of GitHub","description":"Get a random sentence from the Zen of GitHub","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}