{ "openapi": "3.0.3", "info": { "version": "22.0.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, "termsOfService": "https://docs.github.com/articles/github-terms-of-service", "contact": { "name": "Support", "url": "https://github.com/octokit/openapi" }, "x-github-plan": "api.github.com" }, "tags": [ { "name": "actions", "description": "Endpoints to manage GitHub Actions using the REST API." }, { "name": "activity", "description": "Activity APIs provide access to notifications, subscriptions, and timelines." }, { "name": "apps", "description": "Information for integrations and installations." }, { "name": "billing", "description": "Monitor charges and usage from Actions and Packages." }, { "name": "checks", "description": "Rich interactions with checks run by your integrations." }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." }, { "name": "codes-of-conduct", "description": "Insight into codes of conduct for your communities." }, { "name": "emojis", "description": "List emojis available to use on GitHub." }, { "name": "dependabot", "description": "Endpoints to manage Dependabot." }, { "name": "dependency-graph", "description": "Endpoints to access Dependency Graph features." }, { "name": "gists", "description": "View, modify your gists." }, { "name": "git", "description": "Raw Git functionality." }, { "name": "gitignore", "description": "View gitignore templates" }, { "name": "issues", "description": "Interact with GitHub Issues." }, { "name": "licenses", "description": "View various OSS licenses." }, { "name": "markdown", "description": "Render GitHub flavored Markdown" }, { "name": "merge-queue", "description": "Interact with GitHub Merge Queues." }, { "name": "meta", "description": "Endpoints that give information about the API." }, { "name": "migrations", "description": "Move projects to or from GitHub." }, { "name": "oidc", "description": "Endpoints to manage GitHub OIDC configuration using the REST API." }, { "name": "orgs", "description": "Interact with organizations." }, { "name": "packages", "description": "Manage packages for authenticated users and organizations." }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." }, { "name": "rate-limit", "description": "Check your current rate limit status." }, { "name": "reactions", "description": "Interact with reactions to various GitHub entities." }, { "name": "repos", "description": "Interact with GitHub Repos." }, { "name": "search", "description": "Search for specific items on GitHub." }, { "name": "secret-scanning", "description": "Retrieve secret scanning alerts from a repository." }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", "description": "Interact with and view information about users and also current user." }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." }, { "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, { "name": "security-advisories", "description": "Manage security advisories." }, { "name": "interactions", "description": "Owner or admin management of users interactions." }, { "name": "classroom", "description": "Interact with GitHub Classroom." }, { "name": "desktop", "description": "Desktop specific endpoints." }, { "name": "enterprise-teams", "description": "Endpoints to manage GitHub Enterprise Teams." }, { "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, { "name": "enterprise-team-organizations", "description": "Endpoints to manage GitHub Enterprise Team organization assignments." }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." }, { "name": "private-registries", "description": "Manage private registry configurations." }, { "name": "hosted-compute", "description": "Manage hosted compute networking resources." }, { "name": "credentials", "description": "Revoke compromised or leaked GitHub credentials." }, { "name": "campaigns", "description": "Endpoints to manage campaigns via the REST API." }, { "name": "projects", "description": "Endpoints to manage Projects using the REST API." } ], "servers": [ { "url": "https://api.github.com" } ], "externalDocs": { "description": "GitHub v3 REST API", "url": "https://docs.github.com/rest/" }, "paths": { "/": { "get": { "summary": "GitHub API Root", "description": "Get Hypermedia links to resources accessible in GitHub's REST API", "tags": [ "meta" ], "operationId": "meta/root", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "current_user_url": { "type": "string", "format": "uri-template" }, "current_user_authorizations_html_url": { "type": "string", "format": "uri-template" }, "authorizations_url": { "type": "string", "format": "uri-template" }, "code_search_url": { "type": "string", "format": "uri-template" }, "commit_search_url": { "type": "string", "format": "uri-template" }, "emails_url": { "type": "string", "format": "uri-template" }, "emojis_url": { "type": "string", "format": "uri-template" }, "events_url": { "type": "string", "format": "uri-template" }, "feeds_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri-template" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "hub_url": { "type": "string", "format": "uri-template", "deprecated": true }, "issue_search_url": { "type": "string", "format": "uri-template" }, "issues_url": { "type": "string", "format": "uri-template" }, "keys_url": { "type": "string", "format": "uri-template" }, "label_search_url": { "type": "string", "format": "uri-template" }, "notifications_url": { "type": "string", "format": "uri-template" }, "organization_url": { "type": "string", "format": "uri-template" }, "organization_repositories_url": { "type": "string", "format": "uri-template" }, "organization_teams_url": { "type": "string", "format": "uri-template" }, "public_gists_url": { "type": "string", "format": "uri-template" }, "rate_limit_url": { "type": "string", "format": "uri-template" }, "repository_url": { "type": "string", "format": "uri-template" }, "repository_search_url": { "type": "string", "format": "uri-template" }, "current_user_repositories_url": { "type": "string", "format": "uri-template" }, "starred_url": { "type": "string", "format": "uri-template" }, "starred_gists_url": { "type": "string", "format": "uri-template" }, "topic_search_url": { "type": "string", "format": "uri-template" }, "user_url": { "type": "string", "format": "uri-template" }, "user_organizations_url": { "type": "string", "format": "uri-template" }, "user_repositories_url": { "type": "string", "format": "uri-template" }, "user_search_url": { "type": "string", "format": "uri-template" } }, "required": [ "current_user_url", "current_user_authorizations_html_url", "authorizations_url", "code_search_url", "commit_search_url", "emails_url", "emojis_url", "events_url", "feeds_url", "followers_url", "following_url", "gists_url", "issue_search_url", "issues_url", "keys_url", "label_search_url", "notifications_url", "organization_url", "organization_repositories_url", "organization_teams_url", "public_gists_url", "rate_limit_url", "repository_url", "repository_search_url", "current_user_repositories_url", "starred_url", "starred_gists_url", "user_url", "user_organizations_url", "user_repositories_url", "user_search_url" ] }, "examples": { "default": { "value": { "current_user_url": "https://api.github.com/user", "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}", "authorizations_url": "https://api.github.com/authorizations", "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}", "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}", "emails_url": "https://api.github.com/user/emails", "emojis_url": "https://api.github.com/emojis", "events_url": "https://api.github.com/events", "feeds_url": "https://api.github.com/feeds", "followers_url": "https://api.github.com/user/followers", "following_url": "https://api.github.com/user/following{/target}", "gists_url": "https://api.github.com/gists{/gist_id}", "hub_url": "https://api.github.com/hub", "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}", "issues_url": "https://api.github.com/issues", "keys_url": "https://api.github.com/user/keys", "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}", "notifications_url": "https://api.github.com/notifications", "organization_url": "https://api.github.com/orgs/{org}", "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}", "organization_teams_url": "https://api.github.com/orgs/{org}/teams", "public_gists_url": "https://api.github.com/gists/public", "rate_limit_url": "https://api.github.com/rate_limit", "repository_url": "https://api.github.com/repos/{owner}/{repo}", "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}", "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}", "starred_url": "https://api.github.com/user/starred{/owner}{/repo}", "starred_gists_url": "https://api.github.com/gists/starred", "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}", "user_url": "https://api.github.com/users/{user}", "user_organizations_url": "https://api.github.com/user/orgs", "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}", "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "meta", "subcategory": "meta" }, "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/meta/meta#github-api-root" }, "x-octokit": {} } }, "/advisories": { "get": { "summary": "List global security advisories", "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\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).\"", "tags": [ "security-advisories" ], "operationId": "security-advisories/list-global-advisories", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories" }, "parameters": [ { "name": "ghsa_id", "in": "query", "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.", "schema": { "type": "string", "enum": [ "reviewed", "malware", "unreviewed" ], "default": "reviewed" } }, { "name": "cve_id", "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.", "in": "query", "schema": { "type": "string" } }, { "name": "ecosystem", "in": "query", "description": "If specified, only advisories for these ecosystems will be returned.", "schema": { "type": "string", "description": "The package's language or package management ecosystem.", "enum": [ "rubygems", "npm", "pip", "maven", "nuget", "composer", "go", "rust", "erlang", "actions", "pub", "other", "swift" ] } }, { "name": "severity", "in": "query", "description": "If specified, only advisories with these severities will be returned.", "schema": { "type": "string", "enum": [ "unknown", "low", "medium", "high", "critical" ] } }, { "name": "cwes", "in": "query", "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`", "schema": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "is_withdrawn", "in": "query", "description": "Whether to only return advisories that have been withdrawn.", "schema": { "type": "boolean" } }, { "name": "affects", "in": "query", "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\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": { "oneOf": [ { "type": "string" }, { "type": "array", "maxItems": 1000, "items": { "type": "string" } } ] } }, { "name": "published", "in": "query", "description": "If specified, only return advisories that were published on a date or date range.\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" } }, { "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" } }, { "name": "modified", "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).\"", "in": "query", "schema": { "type": "string" } }, { "name": "epss_percentage", "in": "query", "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", "schema": { "type": "string" } }, { "name": "epss_percentile", "in": "query", "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", "schema": { "type": "string" } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "direction", "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } }, { "name": "sort", "description": "The property to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "updated", "published", "epss_percentage", "epss_percentile" ], "default": "published" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "A GitHub Security Advisory.", "type": "object", "properties": { "ghsa_id": { "type": "string", "description": "The GitHub Security Advisory ID.", "readOnly": true }, "cve_id": { "type": "string", "description": "The Common Vulnerabilities and Exposures (CVE) ID.", "nullable": true, "readOnly": true }, "url": { "type": "string", "description": "The API URL for the advisory.", "readOnly": true }, "html_url": { "type": "string", "format": "uri", "description": "The URL for the advisory.", "readOnly": true }, "repository_advisory_url": { "type": "string", "format": "uri", "description": "The API URL for the repository advisory.", "readOnly": true, "nullable": true }, "summary": { "type": "string", "description": "A short summary of the advisory.", "maxLength": 1024 }, "description": { "type": "string", "description": "A detailed description of what the advisory entails.", "maxLength": 65535, "nullable": true }, "type": { "type": "string", "description": "The type of advisory.", "readOnly": true, "enum": [ "reviewed", "unreviewed", "malware" ] }, "severity": { "type": "string", "description": "The severity of the advisory.", "enum": [ "critical", "high", "medium", "low", "unknown" ] }, "source_code_location": { "type": "string", "format": "uri", "description": "The URL of the advisory's source code.", "nullable": true }, "identifiers": { "type": "array", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of identifier.", "enum": [ "CVE", "GHSA" ] }, "value": { "type": "string", "description": "The identifier value." } }, "required": [ "type", "value" ] } }, "references": { "type": "array", "nullable": true, "items": { "type": "string", "description": "URLs with more information regarding the advisory." } }, "published_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was published, in ISO 8601 format.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", "readOnly": true }, "github_reviewed_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", "readOnly": true, "nullable": true }, "nvd_published_at": { "type": "string", "format": "date-time", "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", "readOnly": true, "nullable": true }, "withdrawn_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", "readOnly": true, "nullable": true }, "vulnerabilities": { "type": "array", "description": "The products and respective version ranges affected by the advisory.", "nullable": true, "items": { "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", "type": "object", "properties": { "package": { "description": "The name of the package affected by the vulnerability.", "type": "object", "nullable": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "enum": [ "rubygems", "npm", "pip", "maven", "nuget", "composer", "go", "rust", "erlang", "actions", "pub", "other", "swift" ] }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "nullable": true } }, "required": [ "ecosystem", "name" ] }, "vulnerable_version_range": { "type": "string", "description": "The range of the package versions affected by the vulnerability.", "nullable": true }, "first_patched_version": { "type": "string", "description": "The package version that resolves the vulnerability.", "nullable": true }, "vulnerable_functions": { "type": "array", "description": "The functions in the package that are affected by the vulnerability.", "nullable": true, "readOnly": true, "items": { "type": "string" } } }, "required": [ "package", "vulnerable_version_range", "first_patched_version", "vulnerable_functions" ] } }, "cvss": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS vector.", "nullable": true }, "score": { "type": "number", "description": "The CVSS score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_severities": { "type": "object", "nullable": true, "properties": { "cvss_v3": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 3 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 3 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_v4": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 4 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 4 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] } } }, "epss": { "type": "object", "nullable": true, "readOnly": true, "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", "properties": { "percentage": { "type": "number", "minimum": 0, "maximum": 100 }, "percentile": { "type": "number", "minimum": 0, "maximum": 100 } } }, "cwes": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "cwe_id": { "type": "string", "description": "The Common Weakness Enumeration (CWE) identifier." }, "name": { "type": "string", "description": "The name of the CWE.", "readOnly": true } }, "required": [ "cwe_id", "name" ] } }, "credits": { "type": "array", "description": "The users who contributed to the advisory.", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "type": { "type": "string", "description": "The type of credit the user is receiving.", "enum": [ "analyst", "finder", "reporter", "coordinator", "remediation_developer", "remediation_reviewer", "remediation_verifier", "tool", "sponsor", "other" ] } }, "required": [ "user", "type" ] } } }, "required": [ "ghsa_id", "cve_id", "url", "html_url", "repository_advisory_url", "summary", "description", "type", "severity", "source_code_location", "identifiers", "references", "published_at", "updated_at", "github_reviewed_at", "nvd_published_at", "withdrawn_at", "vulnerabilities", "cvss", "cwes", "credits" ], "additionalProperties": false } }, "examples": { "default": { "value": [ { "id": 1, "ghsa_id": "GHSA-abcd-1234-efgh", "cve_id": "CVE-2050-00000", "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", "summary": "Heartbleed security advisory", "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.", "type": "reviewed", "severity": "high", "source_code_location": "https://github.com/project/a-package", "identifiers": [ { "type": "GHSA", "value": "GHSA-abcd-1234-efgh" }, { "type": "CVE", "value": "CVE-2050-00000" } ], "references": [ "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" ], "published_at": "2023-03-23T02:30:56Z", "updated_at": "2023-03-24T02:30:56Z", "github_reviewed_at": "2023-03-23T02:30:56Z", "nvd_published_at": "2023-03-25T02:30:56Z", "withdrawn_at": null, "vulnerabilities": [ { "package": { "ecosystem": "npm", "name": "a-package" }, "first_patched_version": "1.0.3", "vulnerable_version_range": "<=1.0.2", "vulnerable_functions": [ "a_function" ] } ], "cvss": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, "cvss_v4": { "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", "score": 9.3 } }, "cwes": [ { "cwe_id": "CWE-400", "name": "Uncontrolled Resource Consumption" } ], "epss": [ { "percentage": 0.00045, "percentile": "0.16001e0" } ], "credits": [ { "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "type": "analyst" } ] } ] } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "security-advisories", "subcategory": "global-advisories" }, "x-octokit": {} } }, "/advisories/{ghsa_id}": { "get": { "summary": "Get a global security advisory", "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", "tags": [ "security-advisories" ], "operationId": "security-advisories/get-global-advisory", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" }, "parameters": [ { "name": "ghsa_id", "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "description": "A GitHub Security Advisory.", "type": "object", "properties": { "ghsa_id": { "type": "string", "description": "The GitHub Security Advisory ID.", "readOnly": true }, "cve_id": { "type": "string", "description": "The Common Vulnerabilities and Exposures (CVE) ID.", "nullable": true, "readOnly": true }, "url": { "type": "string", "description": "The API URL for the advisory.", "readOnly": true }, "html_url": { "type": "string", "format": "uri", "description": "The URL for the advisory.", "readOnly": true }, "repository_advisory_url": { "type": "string", "format": "uri", "description": "The API URL for the repository advisory.", "readOnly": true, "nullable": true }, "summary": { "type": "string", "description": "A short summary of the advisory.", "maxLength": 1024 }, "description": { "type": "string", "description": "A detailed description of what the advisory entails.", "maxLength": 65535, "nullable": true }, "type": { "type": "string", "description": "The type of advisory.", "readOnly": true, "enum": [ "reviewed", "unreviewed", "malware" ] }, "severity": { "type": "string", "description": "The severity of the advisory.", "enum": [ "critical", "high", "medium", "low", "unknown" ] }, "source_code_location": { "type": "string", "format": "uri", "description": "The URL of the advisory's source code.", "nullable": true }, "identifiers": { "type": "array", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of identifier.", "enum": [ "CVE", "GHSA" ] }, "value": { "type": "string", "description": "The identifier value." } }, "required": [ "type", "value" ] } }, "references": { "type": "array", "nullable": true, "items": { "type": "string", "description": "URLs with more information regarding the advisory." } }, "published_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was published, in ISO 8601 format.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", "readOnly": true }, "github_reviewed_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", "readOnly": true, "nullable": true }, "nvd_published_at": { "type": "string", "format": "date-time", "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", "readOnly": true, "nullable": true }, "withdrawn_at": { "type": "string", "format": "date-time", "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", "readOnly": true, "nullable": true }, "vulnerabilities": { "type": "array", "description": "The products and respective version ranges affected by the advisory.", "nullable": true, "items": { "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", "type": "object", "properties": { "package": { "description": "The name of the package affected by the vulnerability.", "type": "object", "nullable": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "enum": [ "rubygems", "npm", "pip", "maven", "nuget", "composer", "go", "rust", "erlang", "actions", "pub", "other", "swift" ] }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "nullable": true } }, "required": [ "ecosystem", "name" ] }, "vulnerable_version_range": { "type": "string", "description": "The range of the package versions affected by the vulnerability.", "nullable": true }, "first_patched_version": { "type": "string", "description": "The package version that resolves the vulnerability.", "nullable": true }, "vulnerable_functions": { "type": "array", "description": "The functions in the package that are affected by the vulnerability.", "nullable": true, "readOnly": true, "items": { "type": "string" } } }, "required": [ "package", "vulnerable_version_range", "first_patched_version", "vulnerable_functions" ] } }, "cvss": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS vector.", "nullable": true }, "score": { "type": "number", "description": "The CVSS score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_severities": { "type": "object", "nullable": true, "properties": { "cvss_v3": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 3 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 3 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_v4": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 4 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 4 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] } } }, "epss": { "type": "object", "nullable": true, "readOnly": true, "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", "properties": { "percentage": { "type": "number", "minimum": 0, "maximum": 100 }, "percentile": { "type": "number", "minimum": 0, "maximum": 100 } } }, "cwes": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "cwe_id": { "type": "string", "description": "The Common Weakness Enumeration (CWE) identifier." }, "name": { "type": "string", "description": "The name of the CWE.", "readOnly": true } }, "required": [ "cwe_id", "name" ] } }, "credits": { "type": "array", "description": "The users who contributed to the advisory.", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "type": { "type": "string", "description": "The type of credit the user is receiving.", "enum": [ "analyst", "finder", "reporter", "coordinator", "remediation_developer", "remediation_reviewer", "remediation_verifier", "tool", "sponsor", "other" ] } }, "required": [ "user", "type" ] } } }, "required": [ "ghsa_id", "cve_id", "url", "html_url", "repository_advisory_url", "summary", "description", "type", "severity", "source_code_location", "identifiers", "references", "published_at", "updated_at", "github_reviewed_at", "nvd_published_at", "withdrawn_at", "vulnerabilities", "cvss", "cwes", "credits" ], "additionalProperties": false }, "examples": { "default": { "value": { "ghsa_id": "GHSA-abcd-1234-efgh", "cve_id": "CVE-2050-00000", "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", "summary": "A short summary of the advisory.", "description": "A detailed description of what the advisory entails.", "type": "reviewed", "severity": "high", "source_code_location": "https://github.com/project/a-package", "identifiers": [ { "type": "GHSA", "value": "GHSA-abcd-1234-efgh" }, { "type": "CVE", "value": "CVE-2050-00000" } ], "references": [ "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" ], "published_at": "2023-03-23T02:30:56Z", "updated_at": "2023-03-24T02:30:56Z", "github_reviewed_at": "2023-03-23T02:30:56Z", "nvd_published_at": "2023-03-25T02:30:56Z", "withdrawn_at": null, "vulnerabilities": [ { "package": { "ecosystem": "npm", "name": "a-package" }, "first_patched_version": "1.0.3", "vulnerable_version_range": "<=1.0.2", "vulnerable_functions": [ "a_function" ] } ], "cvss": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, "cvss_v4": { "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", "score": 9.3 } }, "cwes": [ { "cwe_id": "CWE-400", "name": "Uncontrolled Resource Consumption" } ], "credits": [ { "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "type": "analyst" } ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "security-advisories", "subcategory": "global-advisories" }, "x-octokit": {} } }, "/app": { "get": { "summary": "Get the authenticated app", "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/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.", "tags": [ "apps" ], "operationId": "apps/get-authenticated", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#get-the-authenticated-app" }, "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "examples": { "default": { "value": { "id": 1, "slug": "octoapp", "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/app-manifests/{code}/conversions": { "post": { "summary": "Create a GitHub App from a manifest", "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "tags": [ "apps" ], "operationId": "apps/create-from-manifest", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest" }, "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, { "type": "object", "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "webhook_secret": { "type": "string", "nullable": true }, "pem": { "type": "string" } }, "required": [ "client_id", "client_secret", "webhook_secret", "pem" ], "additionalProperties": true } ] }, "examples": { "default": { "value": { "id": 1, "slug": "octoapp", "node_id": "MDxOkludGVncmF0aW9uMQ==", "owner": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": true }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ], "client_id": "Iv1.8a61f9b3a7aba766", "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8", "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa", "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/app/hook/config": { "get": { "summary": "Get a webhook configuration for an app", "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\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.", "tags": [ "apps" ], "operationId": "apps/get-webhook-config-for-app", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, "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).", "example": "\"********\"" }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "example": "\"0\"" }, { "type": "number" } ] } } }, "examples": { "default": { "value": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" }, "x-octokit": {} }, "patch": { "summary": "Update a webhook configuration for an app", "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\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.", "tags": [ "apps" ], "operationId": "apps/update-webhook-config-for-app", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, "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).", "example": "\"********\"" }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "example": "\"0\"" }, { "type": "number" } ] } } }, "examples": { "default": { "value": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Webhook Configuration", "description": "Configuration object of the webhook", "type": "object", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "example": "\"json\"" }, "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).", "example": "\"********\"" }, "insecure_ssl": { "oneOf": [ { "type": "string", "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "example": "\"0\"" }, { "type": "number" } ] } } }, "examples": { "default": { "value": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" }, "x-octokit": {} } }, "/app/hook/deliveries": { "get": { "summary": "List deliveries for an app webhook", "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\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.", "tags": [ "apps" ], "operationId": "apps/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "cursor", "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.", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple webhook delivery", "description": "Delivery made by a webhook, without request and response information.", "type": "object", "properties": { "id": { "description": "Unique identifier of the webhook delivery.", "type": "integer", "format": "int64", "example": 42 }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" }, "delivered_at": { "description": "Time when the webhook delivery occurred.", "type": "string", "format": "date-time", "example": "2021-05-12T20:33:44Z" }, "redelivery": { "description": "Whether the webhook delivery is a redelivery.", "type": "boolean", "example": false }, "duration": { "description": "Time spent delivering.", "type": "number", "example": 0.03 }, "status": { "description": "Describes the response returned after attempting the delivery.", "type": "string", "example": "failed to connect" }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "example": 502 }, "event": { "description": "The event that triggered the delivery.", "type": "string", "example": "issues" }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": "string", "example": "opened", "nullable": true }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", "format": "int64", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", "format": "int64", "example": 123, "nullable": true }, "throttled_at": { "description": "Time when the webhook delivery was throttled.", "type": "string", "format": "date-time", "example": "2021-05-12T20:33:44Z", "nullable": true } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id" ] } }, "examples": { "default": { "value": [ { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "throttled_at": "2019-06-03T00:57:16Z" }, { "id": 123456789, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-04T00:57:16Z", "redelivery": true, "duration": 0.28, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "throttled_at": null } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" }, "x-octokit": {} } }, "/app/hook/deliveries/{delivery_id}": { "get": { "summary": "Get a delivery for an app webhook", "description": "Returns a delivery for the webhook configured for a GitHub App.\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.", "tags": [ "apps" ], "operationId": "apps/get-webhook-delivery", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" }, "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Webhook delivery", "description": "Delivery made by a webhook.", "type": "object", "properties": { "id": { "description": "Unique identifier of the delivery.", "type": "integer", "example": 42 }, "guid": { "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" }, "delivered_at": { "description": "Time when the delivery was delivered.", "type": "string", "format": "date-time", "example": "2021-05-12T20:33:44Z" }, "redelivery": { "description": "Whether the delivery is a redelivery.", "type": "boolean", "example": false }, "duration": { "description": "Time spent delivering.", "type": "number", "example": 0.03 }, "status": { "description": "Description of the status of the attempted delivery", "type": "string", "example": "failed to connect" }, "status_code": { "description": "Status code received when delivery was made.", "type": "integer", "example": 502 }, "event": { "description": "The event that triggered the delivery.", "type": "string", "example": "issues" }, "action": { "description": "The type of activity for the event that triggered the delivery.", "type": "string", "example": "opened", "nullable": true }, "installation_id": { "description": "The id of the GitHub App installation associated with this event.", "type": "integer", "example": 123, "nullable": true }, "repository_id": { "description": "The id of the repository associated with this event.", "type": "integer", "example": 123, "nullable": true }, "throttled_at": { "description": "Time when the webhook delivery was throttled.", "type": "string", "format": "date-time", "example": "2021-05-12T20:33:44Z", "nullable": true }, "url": { "description": "The URL target of the delivery.", "type": "string", "example": "https://www.example.com" }, "request": { "type": "object", "properties": { "headers": { "description": "The request headers sent with the webhook delivery.", "type": "object", "nullable": true, "additionalProperties": true }, "payload": { "description": "The webhook payload.", "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "headers", "payload" ] }, "response": { "type": "object", "properties": { "headers": { "description": "The response headers received when the delivery was made.", "type": "object", "nullable": true, "additionalProperties": true }, "payload": { "description": "The response payload received.", "type": "string", "nullable": true, "additionalProperties": true } }, "required": [ "headers", "payload" ] } }, "required": [ "id", "guid", "delivered_at", "redelivery", "duration", "status", "status_code", "event", "action", "installation_id", "repository_id", "request", "response" ] }, "examples": { "default": { "value": { "id": 12345678, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "delivered_at": "2019-06-03T00:57:16Z", "redelivery": false, "duration": 0.27, "status": "OK", "status_code": 200, "event": "issues", "action": "opened", "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "Accept": "*/*", "X-GitHub-Hook-ID": "42", "User-Agent": "GitHub-Hookshot/b8c71d8", "X-GitHub-Event": "issues", "X-GitHub-Hook-Installation-Target-ID": "123", "X-GitHub-Hook-Installation-Target-Type": "repository", "content-type": "application/json", "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" }, "payload": { "action": "opened", "issue": { "body": "foo" }, "repository": { "id": 123 } } }, "response": { "headers": { "Content-Type": "text/html;charset=utf-8" }, "payload": "ok" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" }, "x-octokit": {} } }, "/app/hook/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an app webhook", "description": "Redeliver a delivery for the webhook configured for a GitHub App.\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.", "tags": [ "apps" ], "operationId": "apps/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" }, "parameters": [ { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "default": { "value": null } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "webhooks" }, "x-octokit": {} } }, "/app/installation-requests": { "get": { "summary": "List installation requests for the authenticated app", "description": "Lists all the pending installation requests for the authenticated GitHub App.", "tags": [ "apps" ], "operationId": "apps/list-installation-requests-for-authenticated-app", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "List of integration installation requests", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Integration Installation Request", "description": "Request to install an integration on a target", "type": "object", "properties": { "id": { "description": "Unique identifier of the request installation.", "type": "integer", "example": 42 }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "account": { "anyOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "requester": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "created_at": { "type": "string", "format": "date-time", "example": "2022-07-08T16:18:44-04:00" } }, "required": [ "id", "account", "requester", "created_at" ] } }, "examples": { "exampleKey1": { "value": [ { "id": 25381, "node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==", "account": { "login": "octo-org", "id": 6811672, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octo-org", "html_url": "https://github.com/octo-org", "followers_url": "https://api.github.com/users/octo-org/followers", "following_url": "https://api.github.com/users/octo-org/following{/other_user}", "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", "organizations_url": "https://api.github.com/users/octo-org/orgs", "repos_url": "https://api.github.com/users/octo-org/repos", "events_url": "https://api.github.com/users/octo-org/events{/privacy}", "received_events_url": "https://api.github.com/users/octo-org/received_events", "type": "Organization", "site_admin": false }, "requester": { "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2022-07-08T16:18:44-04:00" } ] } } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/app/installations": { "get": { "summary": "List installations for the authenticated app", "description": "You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", "tags": [ "apps" ], "operationId": "apps/list-installations", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100).", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "since", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "outdated", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The permissions the installation has are included under the `permissions` key.", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "example": 1 }, "account": { "nullable": true, "allOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "example": "https://api.github.com/installations/1/access_tokens" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/installation/repositories" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/organizations/github/settings/installations/1" }, "app_id": { "type": "integer", "example": 1 }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "example": "Organization" }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "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" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.", "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_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_tokens": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_token_requests": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "events": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "single_file_name": { "type": "string", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "example": "github-actions" }, "suspended_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "suspended_at": { "type": "string", "format": "date-time", "nullable": true }, "contact_email": { "type": "string", "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", "nullable": true } }, "required": [ "id", "app_id", "app_slug", "target_id", "target_type", "single_file_name", "repository_selection", "access_tokens_url", "html_url", "repositories_url", "events", "account", "permissions", "created_at", "updated_at", "suspended_by", "suspended_at" ] } }, "examples": { "default": { "value": [ { "id": 1, "account": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "access_tokens_url": "https://api.github.com/installations/1/access_tokens", "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, "target_id": 1, "target_type": "Organization", "permissions": { "checks": "write", "metadata": "read", "contents": "read" }, "events": [ "push", "pull_request" ], "single_file_name": "config.yaml", "has_multiple_single_files": true, "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ], "repository_selection": "selected", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "app_slug": "github-actions", "suspended_at": null, "suspended_by": null } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/app/installations/{installation_id}": { "get": { "summary": "Get an installation for the authenticated app", "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\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.", "tags": [ "apps" ], "operationId": "apps/get-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "example": 1 }, "account": { "nullable": true, "anyOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "access_tokens_url": { "type": "string", "format": "uri", "example": "https://api.github.com/app/installations/1/access_tokens" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/installation/repositories" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/organizations/github/settings/installations/1" }, "app_id": { "type": "integer", "example": 1 }, "client_id": { "type": "string", "example": "Iv1.ab1112223334445c" }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "example": "Organization" }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "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" ] }, "codespaces": { "type": "string", "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "dependabot_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot secrets.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "discussions": { "type": "string", "description": "The level of permission to grant the access token for discussions and related comments and labels.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "merge_queues": { "type": "string", "description": "The level of permission to grant the access token to manage the merge queues for a repository.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_custom_properties": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", "enum": [ "read", "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom repository roles management.", "enum": [ "read", "write" ] }, "organization_custom_org_roles": { "type": "string", "description": "The level of permission to grant the access token for custom organization roles management.", "enum": [ "read", "write" ] }, "organization_custom_properties": { "type": "string", "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", "enum": [ "read", "write", "admin" ] }, "organization_copilot_seat_management": { "type": "string", "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] }, "organization_announcement_banners": { "type": "string", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", "enum": [ "read", "write" ] }, "organization_events": { "type": "string", "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", "enum": [ "read" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_tokens": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_token_requests": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", "enum": [ "read", "write" ] }, "followers": { "type": "string", "description": "The level of permission to grant the access token to manage the followers belonging to a user.", "enum": [ "read", "write" ] }, "git_ssh_keys": { "type": "string", "description": "The level of permission to grant the access token to manage git SSH keys.", "enum": [ "read", "write" ] }, "gpg_keys": { "type": "string", "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", "enum": [ "read", "write" ] }, "interaction_limits": { "type": "string", "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", "enum": [ "read", "write" ] }, "profile": { "type": "string", "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", "enum": [ "write" ] }, "starring": { "type": "string", "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", "enum": [ "read", "write" ] }, "enterprise_custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", "enum": [ "read", "write", "admin" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "events": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "single_file_name": { "type": "string", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "app_slug": { "type": "string", "example": "github-actions" }, "suspended_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "suspended_at": { "type": "string", "format": "date-time", "nullable": true }, "contact_email": { "type": "string", "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", "nullable": true } }, "required": [ "id", "app_id", "app_slug", "target_id", "target_type", "single_file_name", "repository_selection", "access_tokens_url", "html_url", "repositories_url", "events", "account", "permissions", "created_at", "updated_at", "suspended_by", "suspended_at" ] }, "examples": { "default": { "value": { "id": 1, "account": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, "target_id": 1, "target_type": "Organization", "permissions": { "checks": "write", "metadata": "read", "contents": "read" }, "events": [ "push", "pull_request" ], "single_file_name": "config.yaml", "has_multiple_single_files": true, "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ], "repository_selection": "selected", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "app_slug": "github-actions", "suspended_at": null, "suspended_by": null } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" }, "x-octokit": {} }, "delete": { "summary": "Delete an installation for the authenticated app", "description": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/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.", "tags": [ "apps" ], "operationId": "apps/delete-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an 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\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.", "tags": [ "apps" ], "operationId": "apps/create-installation-access-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "repositories": { "description": "List of repository names that the token should have access to", "type": "array", "items": { "type": "string", "example": "rails" } }, "repository_ids": { "description": "List of repository IDs that the token should have access to", "example": [ 1 ], "type": "array", "items": { "type": "integer" } }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "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" ] }, "codespaces": { "type": "string", "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "dependabot_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot secrets.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "discussions": { "type": "string", "description": "The level of permission to grant the access token for discussions and related comments and labels.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "merge_queues": { "type": "string", "description": "The level of permission to grant the access token to manage the merge queues for a repository.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_custom_properties": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", "enum": [ "read", "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom repository roles management.", "enum": [ "read", "write" ] }, "organization_custom_org_roles": { "type": "string", "description": "The level of permission to grant the access token for custom organization roles management.", "enum": [ "read", "write" ] }, "organization_custom_properties": { "type": "string", "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", "enum": [ "read", "write", "admin" ] }, "organization_copilot_seat_management": { "type": "string", "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] }, "organization_announcement_banners": { "type": "string", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", "enum": [ "read", "write" ] }, "organization_events": { "type": "string", "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", "enum": [ "read" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_tokens": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_token_requests": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", "enum": [ "read", "write" ] }, "followers": { "type": "string", "description": "The level of permission to grant the access token to manage the followers belonging to a user.", "enum": [ "read", "write" ] }, "git_ssh_keys": { "type": "string", "description": "The level of permission to grant the access token to manage git SSH keys.", "enum": [ "read", "write" ] }, "gpg_keys": { "type": "string", "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", "enum": [ "read", "write" ] }, "interaction_limits": { "type": "string", "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", "enum": [ "read", "write" ] }, "profile": { "type": "string", "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", "enum": [ "write" ] }, "starring": { "type": "string", "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", "enum": [ "read", "write" ] }, "enterprise_custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", "enum": [ "read", "write", "admin" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } } } }, "examples": { "default": { "value": { "repositories": [ "Hello-World" ], "permissions": { "issues": "write", "contents": "read" } } } } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "Installation Token", "description": "Authentication token for a GitHub App installed on a user or org.", "type": "object", "properties": { "token": { "type": "string" }, "expires_at": { "type": "string" }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "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" ] }, "codespaces": { "type": "string", "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "dependabot_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot secrets.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "discussions": { "type": "string", "description": "The level of permission to grant the access token for discussions and related comments and labels.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "merge_queues": { "type": "string", "description": "The level of permission to grant the access token to manage the merge queues for a repository.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_custom_properties": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", "enum": [ "read", "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom repository roles management.", "enum": [ "read", "write" ] }, "organization_custom_org_roles": { "type": "string", "description": "The level of permission to grant the access token for custom organization roles management.", "enum": [ "read", "write" ] }, "organization_custom_properties": { "type": "string", "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", "enum": [ "read", "write", "admin" ] }, "organization_copilot_seat_management": { "type": "string", "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] }, "organization_announcement_banners": { "type": "string", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", "enum": [ "read", "write" ] }, "organization_events": { "type": "string", "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", "enum": [ "read" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_tokens": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_token_requests": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", "enum": [ "read", "write" ] }, "followers": { "type": "string", "description": "The level of permission to grant the access token to manage the followers belonging to a user.", "enum": [ "read", "write" ] }, "git_ssh_keys": { "type": "string", "description": "The level of permission to grant the access token to manage git SSH keys.", "enum": [ "read", "write" ] }, "gpg_keys": { "type": "string", "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", "enum": [ "read", "write" ] }, "interaction_limits": { "type": "string", "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", "enum": [ "read", "write" ] }, "profile": { "type": "string", "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", "enum": [ "write" ] }, "starring": { "type": "string", "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", "enum": [ "read", "write" ] }, "enterprise_custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", "enum": [ "read", "write", "admin" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "repository_selection": { "type": "string", "enum": [ "all", "selected" ] }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": "string", "example": "README.md" }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] } }, "required": [ "token", "expires_at" ] }, "examples": { "default": { "value": { "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", "expires_at": "2016-07-11T22:14:10Z", "permissions": { "issues": "write", "contents": "read" }, "repository_selection": "selected", "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/app/installations/{installation_id}/suspended": { "put": { "summary": "Suspend an app installation", "description": "Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub 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.", "tags": [ "apps" ], "operationId": "apps/suspend-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#suspend-an-app-installation" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "apps" ], "operationId": "apps/unsuspend-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation" }, "parameters": [ { "name": "installation_id", "description": "The unique identifier of the installation.", "in": "path", "required": true, "schema": { "type": "integer" }, "examples": { "default": { "value": 1 } } } ], "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/applications/{client_id}/grant": { "delete": { "summary": "Delete an app authorization", "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "operationId": "apps/delete-authorization", "tags": [ "apps" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } }, "required": [ "access_token" ] }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" } } } } } }, "responses": { "204": { "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "oauth-applications" }, "x-octokit": {} } }, "/applications/{client_id}/token": { "post": { "summary": "Check a token", "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/check-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/oauth-applications#check-a-token" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "access_token": { "description": "The access_token of the OAuth or GitHub application.", "type": "string" } }, "required": [ "access_token" ], "type": "object" }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": "array", "items": { "type": "string" }, "nullable": true }, "token": { "type": "string" }, "token_last_eight": { "type": "string", "nullable": true }, "hashed_token": { "type": "string", "nullable": true }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": "string", "nullable": true }, "note_url": { "type": "string", "format": "uri", "nullable": true }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "installation": { "title": "Scoped Installation", "type": "object", "properties": { "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "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" ] }, "codespaces": { "type": "string", "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "dependabot_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot secrets.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "discussions": { "type": "string", "description": "The level of permission to grant the access token for discussions and related comments and labels.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "merge_queues": { "type": "string", "description": "The level of permission to grant the access token to manage the merge queues for a repository.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_custom_properties": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", "enum": [ "read", "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom repository roles management.", "enum": [ "read", "write" ] }, "organization_custom_org_roles": { "type": "string", "description": "The level of permission to grant the access token for custom organization roles management.", "enum": [ "read", "write" ] }, "organization_custom_properties": { "type": "string", "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", "enum": [ "read", "write", "admin" ] }, "organization_copilot_seat_management": { "type": "string", "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] }, "organization_announcement_banners": { "type": "string", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", "enum": [ "read", "write" ] }, "organization_events": { "type": "string", "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", "enum": [ "read" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_tokens": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_token_requests": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", "enum": [ "read", "write" ] }, "followers": { "type": "string", "description": "The level of permission to grant the access token to manage the followers belonging to a user.", "enum": [ "read", "write" ] }, "git_ssh_keys": { "type": "string", "description": "The level of permission to grant the access token to manage git SSH keys.", "enum": [ "read", "write" ] }, "gpg_keys": { "type": "string", "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", "enum": [ "read", "write" ] }, "interaction_limits": { "type": "string", "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", "enum": [ "read", "write" ] }, "profile": { "type": "string", "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", "enum": [ "write" ] }, "starring": { "type": "string", "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", "enum": [ "read", "write" ] }, "enterprise_custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", "enum": [ "read", "write", "admin" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": "string", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "account": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ], "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] }, "examples": { "default": { "value": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo", "user" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "oauth-applications" }, "x-octokit": {} }, "patch": { "summary": "Reset a token", "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/reset-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/oauth-applications#reset-a-token" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "access_token": { "description": "The access_token of the OAuth or GitHub application.", "type": "string" } }, "required": [ "access_token" ], "type": "object" }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": "array", "items": { "type": "string" }, "nullable": true }, "token": { "type": "string" }, "token_last_eight": { "type": "string", "nullable": true }, "hashed_token": { "type": "string", "nullable": true }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": "string", "nullable": true }, "note_url": { "type": "string", "format": "uri", "nullable": true }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "installation": { "title": "Scoped Installation", "type": "object", "properties": { "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "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" ] }, "codespaces": { "type": "string", "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "dependabot_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot secrets.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "discussions": { "type": "string", "description": "The level of permission to grant the access token for discussions and related comments and labels.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "merge_queues": { "type": "string", "description": "The level of permission to grant the access token to manage the merge queues for a repository.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_custom_properties": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", "enum": [ "read", "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom repository roles management.", "enum": [ "read", "write" ] }, "organization_custom_org_roles": { "type": "string", "description": "The level of permission to grant the access token for custom organization roles management.", "enum": [ "read", "write" ] }, "organization_custom_properties": { "type": "string", "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", "enum": [ "read", "write", "admin" ] }, "organization_copilot_seat_management": { "type": "string", "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] }, "organization_announcement_banners": { "type": "string", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", "enum": [ "read", "write" ] }, "organization_events": { "type": "string", "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", "enum": [ "read" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_tokens": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_token_requests": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", "enum": [ "read", "write" ] }, "followers": { "type": "string", "description": "The level of permission to grant the access token to manage the followers belonging to a user.", "enum": [ "read", "write" ] }, "git_ssh_keys": { "type": "string", "description": "The level of permission to grant the access token to manage git SSH keys.", "enum": [ "read", "write" ] }, "gpg_keys": { "type": "string", "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", "enum": [ "read", "write" ] }, "interaction_limits": { "type": "string", "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", "enum": [ "read", "write" ] }, "profile": { "type": "string", "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", "enum": [ "write" ] }, "starring": { "type": "string", "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", "enum": [ "read", "write" ] }, "enterprise_custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", "enum": [ "read", "write", "admin" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": "string", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "account": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ], "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] }, "examples": { "default": { "value": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo", "user" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "oauth-applications" }, "x-octokit": {} }, "delete": { "summary": "Delete an app token", "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "tags": [ "apps" ], "operationId": "apps/delete-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } }, "required": [ "access_token" ] }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" } } } } } }, "responses": { "204": { "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "oauth-applications" }, "x-octokit": {} } }, "/applications/{client_id}/token/scoped": { "post": { "summary": "Create a scoped access token", "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/scope-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#create-a-scoped-access-token" }, "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "The client ID of the GitHub app.", "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "The access token used to authenticate to the GitHub API.", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a" }, "target": { "description": "The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.", "type": "string", "example": "octocat" }, "target_id": { "description": "The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.", "example": 1, "type": "integer" }, "repositories": { "description": "The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified.", "type": "array", "items": { "type": "string", "example": "rails" } }, "repository_ids": { "description": "The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.", "example": [ 1 ], "type": "array", "items": { "type": "integer" } }, "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "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" ] }, "codespaces": { "type": "string", "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "dependabot_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot secrets.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "discussions": { "type": "string", "description": "The level of permission to grant the access token for discussions and related comments and labels.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "merge_queues": { "type": "string", "description": "The level of permission to grant the access token to manage the merge queues for a repository.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_custom_properties": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", "enum": [ "read", "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom repository roles management.", "enum": [ "read", "write" ] }, "organization_custom_org_roles": { "type": "string", "description": "The level of permission to grant the access token for custom organization roles management.", "enum": [ "read", "write" ] }, "organization_custom_properties": { "type": "string", "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", "enum": [ "read", "write", "admin" ] }, "organization_copilot_seat_management": { "type": "string", "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] }, "organization_announcement_banners": { "type": "string", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", "enum": [ "read", "write" ] }, "organization_events": { "type": "string", "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", "enum": [ "read" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_tokens": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_token_requests": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", "enum": [ "read", "write" ] }, "followers": { "type": "string", "description": "The level of permission to grant the access token to manage the followers belonging to a user.", "enum": [ "read", "write" ] }, "git_ssh_keys": { "type": "string", "description": "The level of permission to grant the access token to manage git SSH keys.", "enum": [ "read", "write" ] }, "gpg_keys": { "type": "string", "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", "enum": [ "read", "write" ] }, "interaction_limits": { "type": "string", "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", "enum": [ "read", "write" ] }, "profile": { "type": "string", "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", "enum": [ "write" ] }, "starring": { "type": "string", "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", "enum": [ "read", "write" ] }, "enterprise_custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", "enum": [ "read", "write", "admin" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } } }, "required": [ "access_token" ] }, "examples": { "default": { "value": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", "target": "octocat", "permissions": { "metadata": "read", "issues": "write", "contents": "read" } } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Authorization", "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string", "format": "uri" }, "scopes": { "description": "A list of scopes that this authorization is in.", "type": "array", "items": { "type": "string" }, "nullable": true }, "token": { "type": "string" }, "token_last_eight": { "type": "string", "nullable": true }, "hashed_token": { "type": "string", "nullable": true }, "app": { "type": "object", "properties": { "client_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "client_id", "name", "url" ] }, "note": { "type": "string", "nullable": true }, "note_url": { "type": "string", "format": "uri", "nullable": true }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "installation": { "title": "Scoped Installation", "type": "object", "properties": { "permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the user access token.", "properties": { "actions": { "type": "string", "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", "enum": [ "read", "write" ] }, "administration": { "type": "string", "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", "enum": [ "read", "write" ] }, "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" ] }, "codespaces": { "type": "string", "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", "enum": [ "read", "write" ] }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" ] }, "dependabot_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot secrets.", "enum": [ "read", "write" ] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": [ "read", "write" ] }, "discussions": { "type": "string", "description": "The level of permission to grant the access token for discussions and related comments and labels.", "enum": [ "read", "write" ] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": [ "read", "write" ] }, "issues": { "type": "string", "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", "enum": [ "read", "write" ] }, "merge_queues": { "type": "string", "description": "The level of permission to grant the access token to manage the merge queues for a repository.", "enum": [ "read", "write" ] }, "metadata": { "type": "string", "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", "enum": [ "read", "write" ] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "pages": { "type": "string", "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", "enum": [ "read", "write" ] }, "pull_requests": { "type": "string", "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", "enum": [ "read", "write" ] }, "repository_custom_properties": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", "enum": [ "read", "write" ] }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", "enum": [ "read", "write" ] }, "repository_projects": { "type": "string", "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", "enum": [ "read", "write", "admin" ] }, "secret_scanning_alerts": { "type": "string", "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", "enum": [ "read", "write" ] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": [ "read", "write" ] }, "security_events": { "type": "string", "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", "enum": [ "read", "write" ] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": [ "read", "write" ] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": [ "read", "write" ] }, "vulnerability_alerts": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot alerts.", "enum": [ "read", "write" ] }, "workflows": { "type": "string", "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", "enum": [ "write" ] }, "custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", "enum": [ "read", "write" ] }, "members": { "type": "string", "description": "The level of permission to grant the access token for organization teams and members.", "enum": [ "read", "write" ] }, "organization_administration": { "type": "string", "description": "The level of permission to grant the access token to manage access to an organization.", "enum": [ "read", "write" ] }, "organization_custom_roles": { "type": "string", "description": "The level of permission to grant the access token for custom repository roles management.", "enum": [ "read", "write" ] }, "organization_custom_org_roles": { "type": "string", "description": "The level of permission to grant the access token for custom organization roles management.", "enum": [ "read", "write" ] }, "organization_custom_properties": { "type": "string", "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", "enum": [ "read", "write", "admin" ] }, "organization_copilot_seat_management": { "type": "string", "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] }, "organization_announcement_banners": { "type": "string", "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", "enum": [ "read", "write" ] }, "organization_events": { "type": "string", "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", "enum": [ "read" ] }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_tokens": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", "enum": [ "read", "write" ] }, "organization_personal_access_token_requests": { "type": "string", "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", "enum": [ "read", "write" ] }, "organization_plan": { "type": "string", "description": "The level of permission to grant the access token for viewing an organization's plan.", "enum": [ "read" ] }, "organization_projects": { "type": "string", "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", "admin" ] }, "organization_packages": { "type": "string", "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", "enum": [ "read", "write" ] }, "organization_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage organization secrets.", "enum": [ "read", "write" ] }, "organization_self_hosted_runners": { "type": "string", "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", "enum": [ "read", "write" ] }, "organization_user_blocking": { "type": "string", "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", "enum": [ "read", "write" ] }, "team_discussions": { "type": "string", "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ "read", "write" ] }, "email_addresses": { "type": "string", "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", "enum": [ "read", "write" ] }, "followers": { "type": "string", "description": "The level of permission to grant the access token to manage the followers belonging to a user.", "enum": [ "read", "write" ] }, "git_ssh_keys": { "type": "string", "description": "The level of permission to grant the access token to manage git SSH keys.", "enum": [ "read", "write" ] }, "gpg_keys": { "type": "string", "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", "enum": [ "read", "write" ] }, "interaction_limits": { "type": "string", "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", "enum": [ "read", "write" ] }, "profile": { "type": "string", "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", "enum": [ "write" ] }, "starring": { "type": "string", "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", "enum": [ "read", "write" ] }, "enterprise_custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", "enum": [ "read", "write", "admin" ] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] }, "single_file_name": { "type": "string", "example": "config.yaml", "nullable": true }, "has_multiple_single_files": { "type": "boolean", "example": true }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "example": [ "config.yml", ".github/issue_TEMPLATE.md" ] }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "account": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "permissions", "repository_selection", "single_file_name", "repositories_url", "account" ], "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "app", "id", "note", "note_url", "scopes", "token", "hashed_token", "token_last_eight", "fingerprint", "url", "created_at", "updated_at", "expires_at" ] }, "examples": { "default": { "value": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "Iv1.8a61f9b3a7aba766" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "fingerprint": "jklmnop12345678", "expires_at": "2011-09-08T17:26:27Z", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "installation": { "permissions": { "metadata": "read", "issues": "write", "contents": "read" }, "repository_selection": "selected", "single_file_name": ".github/workflow.yml", "repositories_url": "https://api.github.com/user/repos", "account": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "has_multiple_single_files": false, "single_file_paths": [] } } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/apps/{app_slug}": { "get": { "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`).", "tags": [ "apps" ], "operationId": "apps/get-by-slug", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/apps#get-an-app" }, "parameters": [ { "name": "app_slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "examples": { "default": { "value": { "id": 1, "slug": "octoapp", "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "name": "Octocat App", "description": "", "external_url": "https://example.com", "html_url": "https://github.com/apps/octoapp", "created_at": "2017-07-08T16:18:44-04:00", "updated_at": "2017-07-08T16:18:44-04:00", "permissions": { "metadata": "read", "contents": "read", "issues": "write", "single_file": "write" }, "events": [ "push", "pull_request" ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "apps" }, "x-octokit": {} } }, "/assignments/{assignment_id}": { "get": { "summary": "Get an assignment", "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-an-assignment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" }, "parameters": [ { "name": "assignment_id", "description": "The unique identifier of the classroom assignment.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Classroom Assignment", "description": "A GitHub Classroom assignment", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository.", "type": "integer", "example": 42 }, "public_repo": { "description": "Whether an accepted assignment creates a public repository.", "type": "boolean", "example": true }, "title": { "description": "Assignment title.", "type": "string", "example": "Intro to Binaries" }, "type": { "description": "Whether it's a group assignment or individual assignment.", "type": "string", "example": "individual", "enum": [ "individual", "group" ] }, "invite_link": { "description": "The link that a student can use to accept the assignment.", "type": "string", "example": "https://classroom.github.com/a/Lx7jiUgx" }, "invitations_enabled": { "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", "type": "boolean", "example": true }, "slug": { "description": "Sluggified name of the assignment.", "type": "string", "example": "intro-to-binaries" }, "students_are_repo_admins": { "description": "Whether students are admins on created repository when a student accepts the assignment.", "type": "boolean", "example": true }, "feedback_pull_requests_enabled": { "description": "Whether feedback pull request will be created when a student accepts the assignment.", "type": "boolean", "example": true }, "max_teams": { "description": "The maximum allowable teams for the assignment.", "nullable": true, "type": "integer", "example": 0 }, "max_members": { "description": "The maximum allowable members per team.", "nullable": true, "type": "integer", "example": 0 }, "editor": { "description": "The selected editor for the assignment.", "type": "string", "example": "codespaces" }, "accepted": { "description": "The number of students that have accepted the assignment.", "type": "integer", "example": 25 }, "submitted": { "description": "The number of students that have submitted the assignment.", "type": "integer", "example": 10 }, "passing": { "description": "The number of students that have passed the assignment.", "type": "integer", "example": 10 }, "language": { "description": "The programming language used in the assignment.", "type": "string", "example": "elixir" }, "deadline": { "description": "The time at which the assignment is due.", "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "starter_code_repository": { "title": "Simple Classroom Repository", "description": "A GitHub repository view for Classroom", "type": "object", "properties": { "id": { "type": "integer", "example": 1296269, "description": "A unique identifier of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique name of the repository." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "default_branch": { "type": "string", "example": "main", "description": "The default branch for the repository." } }, "required": [ "id", "full_name", "html_url", "node_id", "private", "default_branch" ] }, "classroom": { "title": "Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Whether classroom is archived.", "type": "boolean", "example": false }, "organization": { "title": "Organization Simple for Classroom", "description": "A GitHub organization.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "login": { "type": "string", "example": "github" }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/github" }, "name": { "type": "string", "example": "Github - Code thigns happen here", "nullable": true }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" } }, "required": [ "id", "login", "node_id", "html_url", "name", "avatar_url" ] }, "url": { "description": "The URL of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "organization", "url" ] } }, "required": [ "id", "public_repo", "title", "type", "invite_link", "invitations_enabled", "slug", "students_are_repo_admins", "feedback_pull_requests_enabled", "max_teams", "max_members", "editor", "accepted", "submitted", "passing", "language", "deadline", "starter_code_repository", "classroom" ] }, "examples": { "default": { "value": { "id": "12,", "public_repo": "false,", "title": "Intro to Binaries", "type": "individual", "invite_link": "https://classroom.github.com/a/Lx7jiUgx", "invitations_enabled": "true,", "slug": "intro-to-binaries", "students_are_repo_admins": false, "feedback_pull_requests_enabled": true, "max_teams": 0, "max_members": 0, "editor": "codespaces", "accepted": 100, "submitted": 40, "passing": 10, "language": "ruby", "deadline": "2011-01-26T19:06:43Z", "stater_code_repository": { "id": 1296269, "full_name": "octocat/Hello-World", "html_url": "https://github.com/octocat/Hello-World", "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "private": false, "default_branch": "main" }, "classroom": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" }, "x-octokit": {} } }, "/assignments/{assignment_id}/accepted_assignments": { "get": { "summary": "List accepted assignments for an assignment", "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/list-accepted-assignments-for-an-assignment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" }, "parameters": [ { "name": "assignment_id", "description": "The unique identifier of the classroom assignment.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Classroom Accepted Assignment", "description": "A GitHub Classroom accepted assignment", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository.", "type": "integer", "example": 42 }, "submitted": { "description": "Whether an accepted assignment has been submitted.", "type": "boolean", "example": true }, "passing": { "description": "Whether a submission passed.", "type": "boolean", "example": true }, "commit_count": { "description": "Count of student commits.", "type": "integer", "example": 5 }, "grade": { "description": "Most recent grade.", "type": "string", "example": "10/10" }, "students": { "type": "array", "items": { "title": "Simple Classroom User", "description": "A GitHub user simplified for Classroom.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "login": { "type": "string", "example": "octocat" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" } }, "required": [ "id", "login", "avatar_url", "html_url" ] } }, "repository": { "title": "Simple Classroom Repository", "description": "A GitHub repository view for Classroom", "type": "object", "properties": { "id": { "type": "integer", "example": 1296269, "description": "A unique identifier of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique name of the repository." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "default_branch": { "type": "string", "example": "main", "description": "The default branch for the repository." } }, "required": [ "id", "full_name", "html_url", "node_id", "private", "default_branch" ] }, "assignment": { "title": "Simple Classroom Assignment", "description": "A GitHub Classroom assignment", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository.", "type": "integer", "example": 42 }, "public_repo": { "description": "Whether an accepted assignment creates a public repository.", "type": "boolean", "example": true }, "title": { "description": "Assignment title.", "type": "string", "example": "Intro to Binaries" }, "type": { "description": "Whether it's a Group Assignment or Individual Assignment.", "type": "string", "example": "individual", "enum": [ "individual", "group" ] }, "invite_link": { "description": "The link that a student can use to accept the assignment.", "type": "string", "example": "https://classroom.github.com/a/Lx7jiUgx" }, "invitations_enabled": { "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", "type": "boolean", "example": true }, "slug": { "description": "Sluggified name of the assignment.", "type": "string", "example": "intro-to-binaries" }, "students_are_repo_admins": { "description": "Whether students are admins on created repository on accepted assignment.", "type": "boolean", "example": true }, "feedback_pull_requests_enabled": { "description": "Whether feedback pull request will be created on assignment acceptance.", "type": "boolean", "example": true }, "max_teams": { "description": "The maximum allowable teams for the assignment.", "nullable": true, "type": "integer", "example": 0 }, "max_members": { "description": "The maximum allowable members per team.", "nullable": true, "type": "integer", "example": 0 }, "editor": { "description": "The selected editor for the assignment.", "type": "string", "example": "codespaces" }, "accepted": { "description": "The number of students that have accepted the assignment.", "type": "integer", "example": 25 }, "submitted": { "description": "The number of students that have submitted the assignment.", "type": "integer", "example": 10 }, "passing": { "description": "The number of students that have passed the assignment.", "type": "integer", "example": 10 }, "language": { "description": "The programming language used in the assignment.", "type": "string", "example": "elixir" }, "deadline": { "description": "The time at which the assignment is due.", "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "classroom": { "title": "Simple Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Returns whether classroom is archived or not.", "type": "boolean", "example": false }, "url": { "description": "The url of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "url" ] } }, "required": [ "id", "public_repo", "title", "type", "invite_link", "invitations_enabled", "slug", "students_are_repo_admins", "feedback_pull_requests_enabled", "editor", "accepted", "submitted", "passing", "language", "deadline", "classroom" ] } }, "required": [ "id", "submitted", "passing", "commit_count", "grade", "students", "repository", "assignment" ] } }, "examples": { "default": { "value": { "id": "12,", "submitted": "false,", "passing": "false,", "commit_count": 5, "grade": "5/10", "students": [ { "id": 1, "login": "octocat", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "html_url": "https://github.com/octocat" } ], "repository": { "id": 1296269, "full_name": "octocat/Hello-World", "html_url": "https://github.com/octocat/Hello-World", "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "private": false, "default_branch": "main" }, "assignment": { "id": "12,", "public_repo": "false,", "title": "Intro to Binaries", "type": "individual", "invite_link": "https://classroom.github.com/a/Lx7jiUgx", "invitations_enabled": "true,", "slug": "intro-to-binaries", "students_are_repo_admins": false, "feedback_pull_requests_enabled": true, "max_teams": 0, "max_members": 0, "editor": "codespaces", "accepted": 100, "submitted": 40, "passing": 10, "language": "ruby", "classroom": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" }, "x-octokit": {} } }, "/assignments/{assignment_id}/grades": { "get": { "summary": "Get assignment grades", "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", "tags": [ "classroom" ], "operationId": "classroom/get-assignment-grades", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" }, "parameters": [ { "name": "assignment_id", "description": "The unique identifier of the classroom assignment.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Classroom Assignment Grade", "description": "Grade for a student or groups GitHub Classroom assignment", "type": "object", "properties": { "assignment_name": { "description": "Name of the assignment", "type": "string" }, "assignment_url": { "description": "URL of the assignment", "type": "string" }, "starter_code_url": { "description": "URL of the starter code for the assignment", "type": "string" }, "github_username": { "description": "GitHub username of the student", "type": "string" }, "roster_identifier": { "description": "Roster identifier of the student", "type": "string" }, "student_repository_name": { "description": "Name of the student's assignment repository", "type": "string" }, "student_repository_url": { "description": "URL of the student's assignment repository", "type": "string" }, "submission_timestamp": { "description": "Timestamp of the student's assignment submission", "type": "string" }, "points_awarded": { "description": "Number of points awarded to the student", "type": "integer" }, "points_available": { "description": "Number of points available for the assignment", "type": "integer" }, "group_name": { "description": "If a group assignment, name of the group the student is in", "type": "string" } }, "required": [ "assignment_name", "assignment_url", "starter_code_url", "github_username", "roster_identifier", "student_repository_name", "student_repository_url", "submission_timestamp", "points_awarded", "points_available" ] } }, "examples": { "default": { "value": [ { "assignment_name": "Introduction to Strings", "assignment_url": "https://classroom.github.com/classrooms/1337/assignments/1337", "starter_code_url": "", "github_username": "octocat", "roster_identifier": "octocat@github.com", "student_repository_name": "intro-to-strings-1337-octocat", "student_repository_url": "https://github.com/timeforschool/intro-to-strings-1337-octocat", "submission_timestamp": "2018-11-12 01:02", "points_awarded": 10, "points_available": 15, "group_name": "octocat-and-friends" }, { "assignment_name": "Introduction to Strings", "assignment_url": "https://classroom.github.com/classrooms/1337/assignments/1337", "starter_code_url": "", "github_username": "monalisa", "roster_identifier": "monalisa@github.com", "student_repository_name": "intro-to-strings-1337-monalisa", "student_repository_url": "https://github.com/timeforschool/intro-to-strings-1337-monalisa", "submission_timestamp": "2018-11-12 01:11", "points_awarded": 15, "points_available": 15, "group_name": "monalisa-and-friends" } ] } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" }, "x-octokit": {} } }, "/classrooms": { "get": { "summary": "List classrooms", "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", "tags": [ "classroom" ], "operationId": "classroom/list-classrooms", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" }, "parameters": [ { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Returns whether classroom is archived or not.", "type": "boolean", "example": false }, "url": { "description": "The url of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "url" ] } }, "examples": { "default": { "value": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" }, "x-octokit": {} } }, "/classrooms/{classroom_id}": { "get": { "summary": "Get a classroom", "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/get-a-classroom", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" }, "parameters": [ { "name": "classroom_id", "description": "The unique identifier of the classroom.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Whether classroom is archived.", "type": "boolean", "example": false }, "organization": { "title": "Organization Simple for Classroom", "description": "A GitHub organization.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "login": { "type": "string", "example": "github" }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/github" }, "name": { "type": "string", "example": "Github - Code thigns happen here", "nullable": true }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" } }, "required": [ "id", "login", "node_id", "html_url", "name", "avatar_url" ] }, "url": { "description": "The URL of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "organization", "url" ] }, "examples": { "default": { "value": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "organization": { "id": 1, "login": "programming-elixir", "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "html_url": "https://github.com/programming-elixir", "name": "Learn how to build fault tolerant applications", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4" }, "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" }, "x-octokit": {} } }, "/classrooms/{classroom_id}/assignments": { "get": { "summary": "List assignments for a classroom", "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", "tags": [ "classroom" ], "operationId": "classroom/list-assignments-for-a-classroom", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" }, "parameters": [ { "name": "classroom_id", "description": "The unique identifier of the classroom.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple Classroom Assignment", "description": "A GitHub Classroom assignment", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository.", "type": "integer", "example": 42 }, "public_repo": { "description": "Whether an accepted assignment creates a public repository.", "type": "boolean", "example": true }, "title": { "description": "Assignment title.", "type": "string", "example": "Intro to Binaries" }, "type": { "description": "Whether it's a Group Assignment or Individual Assignment.", "type": "string", "example": "individual", "enum": [ "individual", "group" ] }, "invite_link": { "description": "The link that a student can use to accept the assignment.", "type": "string", "example": "https://classroom.github.com/a/Lx7jiUgx" }, "invitations_enabled": { "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", "type": "boolean", "example": true }, "slug": { "description": "Sluggified name of the assignment.", "type": "string", "example": "intro-to-binaries" }, "students_are_repo_admins": { "description": "Whether students are admins on created repository on accepted assignment.", "type": "boolean", "example": true }, "feedback_pull_requests_enabled": { "description": "Whether feedback pull request will be created on assignment acceptance.", "type": "boolean", "example": true }, "max_teams": { "description": "The maximum allowable teams for the assignment.", "nullable": true, "type": "integer", "example": 0 }, "max_members": { "description": "The maximum allowable members per team.", "nullable": true, "type": "integer", "example": 0 }, "editor": { "description": "The selected editor for the assignment.", "type": "string", "example": "codespaces" }, "accepted": { "description": "The number of students that have accepted the assignment.", "type": "integer", "example": 25 }, "submitted": { "description": "The number of students that have submitted the assignment.", "type": "integer", "example": 10 }, "passing": { "description": "The number of students that have passed the assignment.", "type": "integer", "example": 10 }, "language": { "description": "The programming language used in the assignment.", "type": "string", "example": "elixir" }, "deadline": { "description": "The time at which the assignment is due.", "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "classroom": { "title": "Simple Classroom", "description": "A GitHub Classroom classroom", "type": "object", "properties": { "id": { "description": "Unique identifier of the classroom.", "example": 42, "type": "integer" }, "name": { "description": "The name of the classroom.", "type": "string", "example": "Programming Elixir" }, "archived": { "description": "Returns whether classroom is archived or not.", "type": "boolean", "example": false }, "url": { "description": "The url of the classroom on GitHub Classroom.", "type": "string", "example": "https://classroom.github.com/classrooms/1-programming-elixir" } }, "required": [ "id", "name", "archived", "url" ] } }, "required": [ "id", "public_repo", "title", "type", "invite_link", "invitations_enabled", "slug", "students_are_repo_admins", "feedback_pull_requests_enabled", "editor", "accepted", "submitted", "passing", "language", "deadline", "classroom" ] } }, "examples": { "default": { "value": { "id": "12,", "public_repo": "false,", "title": "Intro to Binaries", "type": "individual", "invite_link": "https://classroom.github.com/a/Lx7jiUgx", "invitations_enabled": "true,", "slug": "intro-to-binaries", "students_are_repo_admins": false, "feedback_pull_requests_enabled": true, "max_teams": 0, "max_members": 0, "editor": "codespaces", "accepted": 100, "submitted": 40, "passing": 10, "language": "ruby", "deadline": "2020-01-11T11:59:22Z", "classroom": { "id": 1296269, "name": "Programming Elixir", "archived": "false,", "url": "https://classroom.github.com/classrooms/1-programming-elixir" } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "classroom", "subcategory": "classroom" }, "x-octokit": {} } }, "/codes_of_conduct": { "get": { "summary": "Get all codes of conduct", "description": "Returns array of all GitHub's codes of conduct.", "tags": [ "codes-of-conduct" ], "operationId": "codes-of-conduct/get-all-codes-of-conduct", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" }, "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] } }, "examples": { "default": { "value": [ { "key": "citizen_code_of_conduct", "name": "Citizen Code of Conduct", "url": "https://api.github.com/codes_of_conduct/citizen_code_of_conduct", "html_url": "http://citizencodeofconduct.org/" }, { "key": "contributor_covenant", "name": "Contributor Covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "html_url": "https://www.contributor-covenant.org/version/2/0/code_of_conduct/" } ] } } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "codes-of-conduct", "subcategory": "codes-of-conduct" }, "x-octokit": {} } }, "/codes_of_conduct/{key}": { "get": { "summary": "Get a code of conduct", "description": "Returns information about the specified GitHub code of conduct.", "tags": [ "codes-of-conduct" ], "operationId": "codes-of-conduct/get-conduct-code", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" }, "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "examples": { "default": { "value": { "key": "contributor_covenant", "name": "Contributor Covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n", "html_url": "http://contributor-covenant.org/version/1/4/" } } } } } }, "304": { "description": "Not modified" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "codes-of-conduct", "subcategory": "codes-of-conduct" }, "x-octokit": {} } }, "/credentials/revoke": { "post": { "summary": "Revoke a list of credentials", "description": "Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.\n\nThis endpoint currently accepts the following credential types:\n- Personal access tokens (classic)\n- Fine-grained personal access tokens\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.", "tags": [ "credentials" ], "operationId": "credentials/revoke", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "array", "description": "A list of credentials to be revoked, up to 1000 per request.", "items": { "type": "string" }, "minItems": 1, "maxItems": 1000 } }, "required": [ "credentials" ] }, "examples": { "default": { "value": { "credentials": [ "ghp_1234567890abcdef1234567890abcdef12345678", "ghp_abcdef1234567890abcdef1234567890abcdef12" ] } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "default": { "value": null } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "credentials", "subcategory": "revoke" }, "x-octokit": {} } }, "/emojis": { "get": { "summary": "Get emojis", "description": "Lists all the emojis available to use on GitHub.", "operationId": "emojis/get", "tags": [ "emojis" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/emojis/emojis#get-emojis" }, "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "default": { "value": { "100": "https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8", "1234": "https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8", "+1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", "-1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", "1st_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8", "2nd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8", "3rd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8", "8ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8", "a": "https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8", "ab": "https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8", "abacus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8", "abc": "https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8", "abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8", "accept": "https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8", "accessibility": "https://github.githubassets.com/images/icons/emoji/accessibility.png?v8", "accordion": "https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8", "adhesive_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8", "adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8", "aerial_tramway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8", "afghanistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8", "airplane": "https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8", "aland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8", "alarm_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8", "albania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8", "alembic": "https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8", "algeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8", "alien": "https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8", "ambulance": "https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8", "american_samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8", "amphora": "https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8", "anatomical_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8", "anchor": "https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8", "andorra": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8", "angel": "https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8", "anger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8", "angola": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8", "angry": "https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8", "anguilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8", "anguished": "https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8", "ant": "https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8", "antarctica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8", "antigua_barbuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8", "apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8", "aquarius": "https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8", "argentina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8", "aries": "https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8", "armenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8", "arrow_backward": "https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8", "arrow_double_down": "https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8", "arrow_double_up": "https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8", "arrow_down": "https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8", "arrow_down_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8", "arrow_forward": "https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8", "arrow_heading_down": "https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8", "arrow_heading_up": "https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8", "arrow_left": "https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8", "arrow_lower_left": "https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8", "arrow_lower_right": "https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8", "arrow_right": "https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8", "arrow_right_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8", "arrow_up": "https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8", "arrow_up_down": "https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8", "arrow_up_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8", "arrow_upper_left": "https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8", "arrow_upper_right": "https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8", "arrows_clockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8", "arrows_counterclockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8", "art": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8", "articulated_lorry": "https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8", "artificial_satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8", "artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8", "aruba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8", "ascension_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8", "asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8", "astonished": "https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8", "astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8", "athletic_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8", "atm": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8", "atom": "https://github.githubassets.com/images/icons/emoji/atom.png?v8", "atom_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8", "australia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8", "austria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8", "auto_rickshaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8", "avocado": "https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8", "axe": "https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8", "azerbaijan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8", "b": "https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8", "baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8", "baby_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8", "baby_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8", "baby_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8", "back": "https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8", "bacon": "https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8", "badger": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8", "badminton": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8", "bagel": "https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8", "baggage_claim": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8", "baguette_bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8", "bahamas": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8", "bahrain": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8", "balance_scale": "https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8", "bald_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8", "bald_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8", "ballet_shoes": "https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8", "balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8", "ballot_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8", "ballot_box_with_check": "https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8", "bamboo": "https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8", "banana": "https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8", "bangbang": "https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8", "bangladesh": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8", "banjo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8", "bank": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8", "bar_chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8", "barbados": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8", "barber": "https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8", "baseball": "https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8", "basecamp": "https://github.githubassets.com/images/icons/emoji/basecamp.png?v8", "basecampy": "https://github.githubassets.com/images/icons/emoji/basecampy.png?v8", "basket": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8", "basketball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8", "basketball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", "basketball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", "bat": "https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8", "bath": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8", "bathtub": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8", "battery": "https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8", "beach_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8", "bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8", "bearded_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8", "beaver": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8", "bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8", "bee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", "beer": "https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8", "beers": "https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8", "beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8", "beginner": "https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8", "belarus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8", "belgium": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8", "belize": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8", "bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8", "bell_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8", "bellhop_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8", "benin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8", "bento": "https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8", "bermuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8", "beverage_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8", "bhutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8", "bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8", "bike": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8", "biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8", "biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8", "bikini": "https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8", "billed_cap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8", "biohazard": "https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8", "bird": "https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8", "birthday": "https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8", "bison": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8", "black_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8", "black_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8", "black_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8", "black_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8", "black_joker": "https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8", "black_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8", "black_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8", "black_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8", "black_nib": "https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8", "black_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8", "black_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8", "blond_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8", "blond_haired_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8", "blond_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", "blonde_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", "blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8", "blowfish": "https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8", "blue_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8", "blue_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8", "blue_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8", "blue_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8", "blueberries": "https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8", "blush": "https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8", "boar": "https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8", "boat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", "bolivia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8", "bomb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8", "bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8", "book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", "bookmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8", "bookmark_tabs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8", "books": "https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8", "boom": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", "boomerang": "https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8", "boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8", "bosnia_herzegovina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8", "botswana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8", "bouncing_ball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", "bouncing_ball_person": "https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8", "bouncing_ball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", "bouquet": "https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8", "bouvet_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8", "bow": "https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8", "bow_and_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8", "bowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8", "bowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8", "bowl_with_spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8", "bowling": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8", "bowtie": "https://github.githubassets.com/images/icons/emoji/bowtie.png?v8", "boxing_glove": "https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8", "boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8", "brain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8", "brazil": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8", "bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8", "breast_feeding": "https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8", "bricks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8", "bride_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", "bridge_at_night": "https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8", "briefcase": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8", "british_indian_ocean_territory": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8", "british_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8", "broccoli": "https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8", "broken_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8", "broom": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8", "brown_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8", "brown_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8", "brown_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8", "brunei": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8", "bubble_tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8", "bucket": "https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8", "bug": "https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8", "building_construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8", "bulb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8", "bulgaria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8", "bullettrain_front": "https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8", "bullettrain_side": "https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8", "burkina_faso": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8", "burrito": "https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8", "burundi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8", "bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8", "business_suit_levitating": "https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8", "busstop": "https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8", "bust_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8", "busts_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8", "butter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8", "butterfly": "https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8", "cactus": "https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8", "cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8", "calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8", "call_me_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8", "calling": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8", "cambodia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8", "camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8", "camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8", "camera_flash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8", "cameroon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8", "camping": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8", "canada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8", "canary_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8", "cancer": "https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8", "candle": "https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8", "candy": "https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8", "canned_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8", "canoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8", "cape_verde": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8", "capital_abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8", "capricorn": "https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8", "car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", "card_file_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8", "card_index": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8", "card_index_dividers": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8", "caribbean_netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8", "carousel_horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8", "carpentry_saw": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8", "carrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8", "cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8", "cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8", "cat2": "https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8", "cayman_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8", "cd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8", "central_african_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8", "ceuta_melilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8", "chad": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8", "chains": "https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8", "chair": "https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8", "champagne": "https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8", "chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8", "chart_with_downwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8", "chart_with_upwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8", "checkered_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8", "cheese": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8", "cherries": "https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8", "cherry_blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8", "chess_pawn": "https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8", "chestnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8", "chicken": "https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8", "child": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8", "children_crossing": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8", "chile": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8", "chipmunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8", "chocolate_bar": "https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8", "chopsticks": "https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8", "christmas_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8", "christmas_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8", "church": "https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8", "cinema": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8", "circus_tent": "https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8", "city_sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8", "city_sunset": "https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8", "cityscape": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8", "cl": "https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8", "clamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8", "clap": "https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8", "clapper": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8", "classical_building": "https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8", "climbing": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8", "climbing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8", "climbing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8", "clinking_glasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8", "clipboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8", "clipperton_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8", "clock1": "https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8", "clock10": "https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8", "clock1030": "https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8", "clock11": "https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8", "clock1130": "https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8", "clock12": "https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8", "clock1230": "https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8", "clock130": "https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8", "clock2": "https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8", "clock230": "https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8", "clock3": "https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8", "clock330": "https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8", "clock4": "https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8", "clock430": "https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8", "clock5": "https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8", "clock530": "https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8", "clock6": "https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8", "clock630": "https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8", "clock7": "https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8", "clock730": "https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8", "clock8": "https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8", "clock830": "https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8", "clock9": "https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8", "clock930": "https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8", "closed_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8", "closed_lock_with_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8", "closed_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8", "cloud": "https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8", "cloud_with_lightning": "https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8", "cloud_with_lightning_and_rain": "https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8", "cloud_with_rain": "https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8", "cloud_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8", "clown_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8", "clubs": "https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8", "cn": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8", "coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8", "cockroach": "https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8", "cocktail": "https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8", "coconut": "https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8", "cocos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8", "coffee": "https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8", "coffin": "https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8", "coin": "https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8", "cold_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8", "cold_sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8", "collision": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", "colombia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8", "comet": "https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8", "comoros": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8", "compass": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8", "computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8", "computer_mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8", "confetti_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8", "confounded": "https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8", "confused": "https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8", "congo_brazzaville": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8", "congo_kinshasa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8", "congratulations": "https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8", "construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8", "construction_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8", "construction_worker_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8", "construction_worker_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8", "control_knobs": "https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8", "convenience_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8", "cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8", "cook_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8", "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", "cote_divoire": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8", "couch_and_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8", "couple": "https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8", "couple_with_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8", "couple_with_heart_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8", "couple_with_heart_woman_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8", "couple_with_heart_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8", "couplekiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8", "couplekiss_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8", "couplekiss_man_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8", "couplekiss_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8", "cow": "https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8", "cow2": "https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8", "cowboy_hat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8", "crab": "https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8", "crayon": "https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8", "credit_card": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8", "crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8", "cricket": "https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8", "cricket_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8", "croatia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8", "crocodile": "https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8", "croissant": "https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8", "crossed_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8", "crossed_flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8", "crossed_swords": "https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8", "crown": "https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8", "cry": "https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8", "crying_cat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8", "crystal_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8", "cuba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8", "cucumber": "https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8", "cup_with_straw": "https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8", "cupcake": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8", "cupid": "https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8", "curacao": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8", "curling_stone": "https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8", "curly_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8", "curly_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8", "curly_loop": "https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8", "currency_exchange": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8", "curry": "https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8", "cursing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8", "custard": "https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8", "customs": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8", "cut_of_meat": "https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8", "cyclone": "https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8", "cyprus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8", "czech_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8", "dagger": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8", "dancer": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", "dancers": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8", "dancing_men": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8", "dancing_women": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8", "dango": "https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8", "dark_sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8", "dart": "https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8", "dash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8", "date": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8", "de": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8", "deaf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8", "deaf_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8", "deaf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8", "deciduous_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8", "deer": "https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8", "denmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8", "department_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8", "dependabot": "https://github.githubassets.com/images/icons/emoji/dependabot.png?v8", "derelict_house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8", "desert": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8", "desert_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8", "desktop_computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8", "detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8", "diamond_shape_with_a_dot_inside": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8", "diamonds": "https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8", "diego_garcia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8", "disappointed": "https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8", "disappointed_relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8", "disguised_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8", "diving_mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8", "diya_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8", "dizzy": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8", "dizzy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8", "djibouti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8", "dna": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8", "do_not_litter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8", "dodo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8", "dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8", "dog2": "https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8", "dollar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8", "dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8", "dolphin": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", "dominica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8", "dominican_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8", "door": "https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8", "doughnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8", "dove": "https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8", "dragon": "https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8", "dragon_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8", "dress": "https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8", "dromedary_camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8", "drooling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8", "drop_of_blood": "https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8", "droplet": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8", "drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8", "duck": "https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8", "dumpling": "https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8", "dvd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8", "e-mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", "eagle": "https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8", "ear": "https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8", "ear_of_rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8", "ear_with_hearing_aid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8", "earth_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8", "earth_americas": "https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8", "earth_asia": "https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8", "ecuador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8", "egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8", "eggplant": "https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8", "egypt": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8", "eight": "https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8", "eight_pointed_black_star": "https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8", "eight_spoked_asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8", "eject_button": "https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8", "el_salvador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8", "electric_plug": "https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8", "electron": "https://github.githubassets.com/images/icons/emoji/electron.png?v8", "elephant": "https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8", "elevator": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8", "elf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8", "elf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8", "elf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8", "email": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", "end": "https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8", "england": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8", "envelope": "https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8", "envelope_with_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8", "equatorial_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8", "eritrea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8", "es": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8", "estonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8", "ethiopia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8", "eu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", "euro": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8", "european_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8", "european_post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8", "european_union": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", "evergreen_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8", "exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", "exploding_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8", "expressionless": "https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8", "eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8", "eye_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8", "eyeglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8", "eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8", "face_exhaling": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8", "face_in_clouds": "https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8", "face_with_head_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8", "face_with_spiral_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8", "face_with_thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8", "facepalm": "https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8", "facepunch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "factory": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8", "factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8", "fairy": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8", "fairy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8", "fairy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8", "falafel": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8", "falkland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8", "fallen_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8", "family": "https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8", "family_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8", "family_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8", "family_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8", "family_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8", "family_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8", "family_man_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8", "family_man_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8", "family_man_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8", "family_man_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8", "family_man_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8", "family_man_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8", "family_man_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8", "family_man_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8", "family_man_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8", "family_man_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8", "family_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8", "family_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8", "family_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8", "family_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8", "family_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8", "family_woman_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8", "family_woman_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8", "family_woman_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8", "family_woman_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8", "family_woman_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8", "farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8", "faroe_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8", "fast_forward": "https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8", "fax": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8", "fearful": "https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8", "feather": "https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8", "feelsgood": "https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8", "feet": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", "female_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8", "female_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8", "ferris_wheel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8", "ferry": "https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8", "field_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8", "fiji": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8", "file_cabinet": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8", "file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8", "film_projector": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8", "film_strip": "https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8", "finland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8", "finnadie": "https://github.githubassets.com/images/icons/emoji/finnadie.png?v8", "fire": "https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8", "fire_engine": "https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8", "fire_extinguisher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8", "firecracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8", "firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8", "fireworks": "https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8", "first_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8", "first_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8", "fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8", "fish_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8", "fishsticks": "https://github.githubassets.com/images/icons/emoji/fishsticks.png?v8", "fishing_pole_and_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8", "fist": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", "fist_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8", "fist_oncoming": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "fist_raised": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", "fist_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8", "five": "https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8", "flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8", "flamingo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8", "flashlight": "https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8", "flat_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8", "flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8", "fleur_de_lis": "https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8", "flight_arrival": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8", "flight_departure": "https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8", "flipper": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", "floppy_disk": "https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8", "flower_playing_cards": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8", "flushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8", "fly": "https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8", "flying_disc": "https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8", "flying_saucer": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8", "fog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8", "foggy": "https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8", "fondue": "https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8", "foot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8", "football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8", "footprints": "https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8", "fork_and_knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8", "fortune_cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8", "fountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8", "fountain_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8", "four": "https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8", "four_leaf_clover": "https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8", "fox_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8", "fr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8", "framed_picture": "https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8", "free": "https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8", "french_guiana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8", "french_polynesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8", "french_southern_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8", "fried_egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8", "fried_shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8", "fries": "https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8", "frog": "https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8", "frowning": "https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8", "frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8", "frowning_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8", "frowning_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8", "frowning_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8", "fu": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", "fuelpump": "https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8", "full_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8", "full_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8", "funeral_urn": "https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8", "gabon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8", "gambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8", "game_die": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8", "garlic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8", "gb": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", "gear": "https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8", "gem": "https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8", "gemini": "https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8", "genie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8", "genie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8", "genie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8", "georgia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8", "ghana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8", "ghost": "https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8", "gibraltar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8", "gift": "https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8", "gift_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8", "giraffe": "https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8", "girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8", "globe_with_meridians": "https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8", "gloves": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8", "goal_net": "https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8", "goat": "https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8", "goberserk": "https://github.githubassets.com/images/icons/emoji/goberserk.png?v8", "godmode": "https://github.githubassets.com/images/icons/emoji/godmode.png?v8", "goggles": "https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8", "golf": "https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8", "golfing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8", "golfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8", "golfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8", "gorilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8", "grapes": "https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8", "greece": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8", "green_apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8", "green_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8", "green_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8", "green_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8", "green_salad": "https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8", "green_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8", "greenland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8", "grenada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8", "grey_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8", "grey_question": "https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8", "grimacing": "https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8", "grin": "https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8", "grinning": "https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8", "guadeloupe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8", "guam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8", "guard": "https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8", "guardsman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8", "guardswoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8", "guatemala": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8", "guernsey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8", "guide_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8", "guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8", "guinea_bissau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8", "guitar": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8", "gun": "https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8", "guyana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8", "haircut": "https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8", "haircut_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8", "haircut_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8", "haiti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8", "hamburger": "https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8", "hammer": "https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8", "hammer_and_pick": "https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8", "hammer_and_wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8", "hamster": "https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8", "hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", "hand_over_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8", "handbag": "https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8", "handball_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8", "handshake": "https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8", "hankey": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", "hash": "https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8", "hatched_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8", "hatching_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8", "headphones": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8", "headstone": "https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8", "health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8", "hear_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8", "heard_mcdonald_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8", "heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8", "heart_decoration": "https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8", "heart_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8", "heart_eyes_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8", "heart_on_fire": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8", "heartbeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8", "heartpulse": "https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8", "hearts": "https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8", "heavy_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8", "heavy_division_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8", "heavy_dollar_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8", "heavy_exclamation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", "heavy_heart_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8", "heavy_minus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8", "heavy_multiplication_x": "https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8", "heavy_plus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8", "hedgehog": "https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8", "helicopter": "https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8", "herb": "https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8", "hibiscus": "https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8", "high_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8", "high_heel": "https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8", "hiking_boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8", "hindu_temple": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8", "hippopotamus": "https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8", "hocho": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", "hole": "https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8", "honduras": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8", "honey_pot": "https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8", "honeybee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", "hong_kong": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8", "hook": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8", "horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8", "horse_racing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8", "hospital": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8", "hot_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8", "hot_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8", "hotdog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8", "hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8", "hotsprings": "https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8", "hourglass": "https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8", "hourglass_flowing_sand": "https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8", "house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8", "house_with_garden": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8", "houses": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8", "hugs": "https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8", "hungary": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8", "hurtrealbad": "https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8", "hushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8", "hut": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8", "ice_cream": "https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8", "ice_cube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8", "ice_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8", "ice_skate": "https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8", "icecream": "https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8", "iceland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8", "id": "https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8", "ideograph_advantage": "https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8", "imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8", "inbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8", "incoming_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8", "india": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8", "indonesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8", "infinity": "https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8", "information_desk_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", "information_source": "https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8", "innocent": "https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8", "interrobang": "https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8", "iphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8", "iran": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8", "iraq": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8", "ireland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8", "isle_of_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8", "israel": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8", "it": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8", "izakaya_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", "jack_o_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8", "jamaica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8", "japan": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8", "japanese_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8", "japanese_goblin": "https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8", "japanese_ogre": "https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8", "jeans": "https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8", "jersey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8", "jigsaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8", "jordan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8", "joy": "https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8", "joy_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8", "joystick": "https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8", "jp": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8", "judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8", "juggling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8", "kangaroo": "https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8", "kazakhstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8", "kenya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8", "key": "https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8", "keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8", "keycap_ten": "https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8", "kick_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8", "kimono": "https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8", "kiribati": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8", "kiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8", "kissing": "https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8", "kissing_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8", "kissing_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8", "kissing_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8", "kissing_smiling_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8", "kite": "https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8", "kiwi_fruit": "https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8", "kneeling_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8", "kneeling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8", "kneeling_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8", "knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", "knot": "https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8", "koala": "https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8", "koko": "https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8", "kosovo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8", "kr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8", "kuwait": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8", "kyrgyzstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8", "lab_coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8", "label": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8", "lacrosse": "https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8", "ladder": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8", "lady_beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8", "lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", "laos": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8", "large_blue_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8", "large_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8", "large_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8", "last_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8", "last_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8", "latin_cross": "https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8", "latvia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8", "laughing": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", "leafy_green": "https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8", "leaves": "https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8", "lebanon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8", "ledger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8", "left_luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8", "left_right_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8", "left_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8", "leftwards_arrow_with_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8", "leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8", "lemon": "https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8", "leo": "https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8", "leopard": "https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8", "lesotho": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8", "level_slider": "https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8", "liberia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8", "libra": "https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8", "libya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8", "liechtenstein": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8", "light_rail": "https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8", "link": "https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8", "lion": "https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8", "lips": "https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8", "lipstick": "https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8", "lithuania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8", "lizard": "https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8", "llama": "https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8", "lobster": "https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8", "lock": "https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8", "lock_with_ink_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8", "lollipop": "https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8", "long_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8", "loop": "https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8", "lotion_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8", "lotus_position": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8", "lotus_position_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8", "lotus_position_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8", "loud_sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8", "loudspeaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8", "love_hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8", "love_letter": "https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8", "love_you_gesture": "https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8", "low_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8", "luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8", "lungs": "https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8", "luxembourg": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8", "lying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8", "m": "https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8", "macau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8", "macedonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8", "madagascar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8", "mag": "https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8", "mag_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8", "mage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8", "mage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8", "mage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8", "magic_wand": "https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8", "magnet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8", "mahjong": "https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8", "mailbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8", "mailbox_closed": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8", "mailbox_with_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8", "mailbox_with_no_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8", "malawi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8", "malaysia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8", "maldives": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8", "male_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8", "male_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8", "mali": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8", "malta": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8", "mammoth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8", "man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8", "man_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8", "man_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8", "man_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8", "man_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8", "man_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8", "man_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8", "man_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8", "man_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8", "man_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8", "man_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8", "man_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8", "man_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8", "man_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8", "man_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8", "man_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8", "man_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8", "man_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8", "man_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8", "man_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8", "man_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8", "man_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8", "man_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8", "man_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8", "man_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8", "man_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8", "man_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8", "man_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8", "man_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8", "man_with_gua_pi_mao": "https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8", "man_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8", "man_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8", "man_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8", "mandarin": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "mango": "https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8", "mans_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", "mantelpiece_clock": "https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8", "manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8", "maple_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8", "marshall_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8", "martial_arts_uniform": "https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8", "martinique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8", "mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8", "massage": "https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8", "massage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8", "massage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8", "mate": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8", "mauritania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8", "mauritius": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8", "mayotte": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8", "meat_on_bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8", "mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8", "mechanical_arm": "https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8", "mechanical_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8", "medal_military": "https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8", "medal_sports": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8", "medical_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8", "mega": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8", "melon": "https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8", "memo": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", "men_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8", "mending_heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8", "menorah": "https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8", "mens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8", "mermaid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8", "merman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8", "merperson": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8", "metal": "https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8", "metro": "https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8", "mexico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8", "microbe": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8", "micronesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8", "microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8", "microscope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8", "middle_finger": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", "military_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8", "milk_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8", "milky_way": "https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8", "minibus": "https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8", "minidisc": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8", "mirror": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8", "mobile_phone_off": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8", "moldova": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8", "monaco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8", "money_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8", "money_with_wings": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8", "moneybag": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8", "mongolia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8", "monkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8", "monkey_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8", "monocle_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8", "monorail": "https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8", "montenegro": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8", "montserrat": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8", "moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", "moon_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8", "morocco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8", "mortar_board": "https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8", "mosque": "https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8", "mosquito": "https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8", "motor_boat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8", "motor_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8", "motorcycle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8", "motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8", "motorway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8", "mount_fuji": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8", "mountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8", "mountain_bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8", "mountain_biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8", "mountain_biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8", "mountain_cableway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8", "mountain_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8", "mountain_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8", "mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8", "mouse2": "https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8", "mouse_trap": "https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8", "movie_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8", "moyai": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8", "mozambique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8", "mrs_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8", "muscle": "https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8", "mushroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8", "musical_keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8", "musical_note": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8", "musical_score": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8", "mute": "https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8", "mx_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8", "myanmar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8", "nail_care": "https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8", "name_badge": "https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8", "namibia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8", "national_park": "https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8", "nauru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8", "nauseated_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8", "nazar_amulet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8", "neckbeard": "https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8", "necktie": "https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8", "negative_squared_cross_mark": "https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8", "nepal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8", "nerd_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8", "nesting_dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8", "netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8", "neutral_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8", "new": "https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8", "new_caledonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8", "new_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8", "new_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8", "new_zealand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8", "newspaper": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8", "newspaper_roll": "https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8", "next_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8", "ng": "https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8", "ng_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", "ng_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", "nicaragua": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8", "niger": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8", "nigeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8", "night_with_stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8", "nine": "https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8", "ninja": "https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8", "niue": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8", "no_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8", "no_bicycles": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8", "no_entry": "https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8", "no_entry_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8", "no_good": "https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8", "no_good_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", "no_good_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", "no_mobile_phones": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8", "no_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8", "no_pedestrians": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8", "no_smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8", "non-potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8", "norfolk_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8", "north_korea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8", "northern_mariana_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8", "norway": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8", "nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8", "notebook": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8", "notebook_with_decorative_cover": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8", "notes": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8", "nut_and_bolt": "https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8", "o": "https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8", "o2": "https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8", "ocean": "https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8", "octocat": "https://github.githubassets.com/images/icons/emoji/octocat.png?v8", "octopus": "https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8", "oden": "https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8", "office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8", "office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8", "oil_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8", "ok": "https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8", "ok_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8", "ok_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8", "ok_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8", "ok_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8", "old_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8", "older_adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8", "older_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8", "older_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8", "olive": "https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8", "om": "https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8", "oman": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8", "on": "https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8", "oncoming_automobile": "https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8", "oncoming_bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8", "oncoming_police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8", "oncoming_taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8", "one": "https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8", "one_piece_swimsuit": "https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8", "onion": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8", "open_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", "open_file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8", "open_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8", "open_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8", "open_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8", "ophiuchus": "https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8", "orange": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "orange_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8", "orange_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8", "orange_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8", "orange_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8", "orangutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8", "orthodox_cross": "https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8", "otter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8", "outbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8", "owl": "https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8", "ox": "https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8", "oyster": "https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8", "package": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8", "page_facing_up": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8", "page_with_curl": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8", "pager": "https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8", "paintbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8", "pakistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8", "palau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8", "palestinian_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8", "palm_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8", "palms_up_together": "https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8", "panama": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8", "pancakes": "https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8", "panda_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8", "paperclip": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8", "paperclips": "https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8", "papua_new_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8", "parachute": "https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8", "paraguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8", "parasol_on_ground": "https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8", "parking": "https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8", "parrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8", "part_alternation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8", "partly_sunny": "https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8", "partying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8", "passenger_ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8", "passport_control": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8", "pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8", "paw_prints": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", "peace_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8", "peach": "https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8", "peacock": "https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8", "peanuts": "https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8", "pear": "https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8", "pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8", "pencil": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", "pencil2": "https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8", "penguin": "https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8", "pensive": "https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8", "people_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8", "people_hugging": "https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8", "performing_arts": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8", "persevere": "https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8", "person_bald": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8", "person_curly_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8", "person_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8", "person_fencing": "https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8", "person_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8", "person_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8", "person_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8", "person_red_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8", "person_white_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8", "person_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8", "person_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8", "person_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8", "peru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8", "petri_dish": "https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8", "philippines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8", "phone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", "pick": "https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8", "pickup_truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8", "pie": "https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8", "pig": "https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8", "pig2": "https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8", "pig_nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8", "pill": "https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8", "pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8", "pinata": "https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8", "pinched_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8", "pinching_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8", "pineapple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8", "ping_pong": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8", "pirate_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8", "pisces": "https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8", "pitcairn_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8", "pizza": "https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8", "placard": "https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8", "place_of_worship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8", "plate_with_cutlery": "https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8", "play_or_pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8", "pleading_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8", "plunger": "https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8", "point_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8", "point_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8", "point_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8", "point_up": "https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8", "point_up_2": "https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8", "poland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8", "polar_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8", "police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8", "police_officer": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", "policeman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8", "policewoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8", "poodle": "https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8", "poop": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", "popcorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8", "portugal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8", "post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8", "postal_horn": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8", "postbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8", "potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8", "potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8", "potted_plant": "https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8", "pouch": "https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8", "poultry_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8", "pound": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8", "pout": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", "pouting_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8", "pouting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8", "pouting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8", "pouting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8", "pray": "https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8", "prayer_beads": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8", "pregnant_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8", "pretzel": "https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8", "previous_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8", "prince": "https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8", "princess": "https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8", "printer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8", "probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8", "puerto_rico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8", "punch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", "purple_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8", "purple_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8", "purple_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8", "purse": "https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8", "pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8", "put_litter_in_its_place": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8", "qatar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8", "question": "https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8", "rabbit": "https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8", "rabbit2": "https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8", "raccoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8", "racehorse": "https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8", "racing_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8", "radio": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8", "radio_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8", "radioactive": "https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8", "rage": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", "rage1": "https://github.githubassets.com/images/icons/emoji/rage1.png?v8", "rage2": "https://github.githubassets.com/images/icons/emoji/rage2.png?v8", "rage3": "https://github.githubassets.com/images/icons/emoji/rage3.png?v8", "rage4": "https://github.githubassets.com/images/icons/emoji/rage4.png?v8", "railway_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8", "railway_track": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8", "rainbow": "https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8", "rainbow_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8", "raised_back_of_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8", "raised_eyebrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8", "raised_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", "raised_hand_with_fingers_splayed": "https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8", "raised_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8", "raising_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8", "raising_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8", "raising_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8", "ram": "https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8", "ramen": "https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8", "rat": "https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8", "razor": "https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8", "receipt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8", "record_button": "https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8", "recycle": "https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8", "red_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", "red_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8", "red_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8", "red_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8", "red_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8", "red_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8", "registered": "https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8", "relaxed": "https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8", "relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8", "reminder_ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8", "repeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8", "repeat_one": "https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8", "rescue_worker_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8", "restroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8", "reunion": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8", "revolving_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8", "rewind": "https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8", "rhinoceros": "https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8", "ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8", "rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8", "rice_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8", "rice_cracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8", "rice_scene": "https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8", "right_anger_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8", "ring": "https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8", "ringed_planet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8", "robot": "https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8", "rock": "https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8", "rocket": "https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8", "rofl": "https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8", "roll_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8", "roll_of_paper": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8", "roller_coaster": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8", "roller_skate": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8", "romania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8", "rooster": "https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8", "rose": "https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8", "rosette": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8", "rotating_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8", "round_pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8", "rowboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8", "rowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8", "rowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8", "ru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8", "rugby_football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8", "runner": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", "running": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", "running_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8", "running_shirt_with_sash": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8", "running_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8", "rwanda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8", "sa": "https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8", "safety_pin": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8", "safety_vest": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8", "sagittarius": "https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8", "sailboat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", "sake": "https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8", "salt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8", "samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8", "san_marino": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8", "sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8", "sandwich": "https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8", "santa": "https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8", "sao_tome_principe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8", "sari": "https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8", "sassy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", "sassy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", "satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8", "satisfied": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", "saudi_arabia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8", "sauna_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8", "sauna_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8", "sauna_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8", "sauropod": "https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8", "saxophone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8", "scarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8", "school": "https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8", "school_satchel": "https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8", "scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8", "scissors": "https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8", "scorpion": "https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8", "scorpius": "https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8", "scotland": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8", "scream": "https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8", "scream_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8", "screwdriver": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8", "scroll": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8", "seal": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8", "seat": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8", "secret": "https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8", "see_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8", "seedling": "https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8", "selfie": "https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8", "senegal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8", "serbia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8", "service_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8", "seven": "https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8", "sewing_needle": "https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8", "seychelles": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8", "shallow_pan_of_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8", "shamrock": "https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8", "shark": "https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8", "shaved_ice": "https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8", "sheep": "https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8", "shell": "https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8", "shield": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8", "shinto_shrine": "https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8", "ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8", "shipit": "https://github.githubassets.com/images/icons/emoji/shipit.png?v8", "shirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", "shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", "shopping": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8", "shopping_cart": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8", "shorts": "https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8", "shower": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8", "shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8", "shrug": "https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8", "shushing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8", "sierra_leone": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8", "signal_strength": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8", "singapore": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8", "singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8", "sint_maarten": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8", "six": "https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8", "six_pointed_star": "https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8", "skateboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8", "ski": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8", "skier": "https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8", "skull": "https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8", "skull_and_crossbones": "https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8", "skunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8", "sled": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8", "sleeping": "https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8", "sleeping_bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8", "sleepy": "https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8", "slightly_frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8", "slightly_smiling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8", "slot_machine": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8", "sloth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8", "slovakia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8", "slovenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8", "small_airplane": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8", "small_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8", "small_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8", "small_red_triangle": "https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8", "small_red_triangle_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8", "smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8", "smile_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8", "smiley": "https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8", "smiley_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8", "smiling_face_with_tear": "https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8", "smiling_face_with_three_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8", "smiling_imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8", "smirk": "https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8", "smirk_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8", "smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8", "snail": "https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8", "snake": "https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8", "sneezing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8", "snowboarder": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8", "snowflake": "https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8", "snowman": "https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8", "snowman_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8", "soap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8", "sob": "https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8", "soccer": "https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8", "socks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8", "softball": "https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8", "solomon_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8", "somalia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8", "soon": "https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8", "sos": "https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8", "sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8", "south_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8", "south_georgia_south_sandwich_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8", "south_sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8", "space_invader": "https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8", "spades": "https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8", "spaghetti": "https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8", "sparkle": "https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8", "sparkler": "https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8", "sparkles": "https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8", "sparkling_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8", "speak_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8", "speaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8", "speaking_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8", "speech_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8", "speedboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8", "spider": "https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8", "spider_web": "https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8", "spiral_calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8", "spiral_notepad": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8", "sponge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8", "spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8", "squid": "https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8", "sri_lanka": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8", "st_barthelemy": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8", "st_helena": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8", "st_kitts_nevis": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8", "st_lucia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8", "st_martin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8", "st_pierre_miquelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8", "st_vincent_grenadines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8", "stadium": "https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8", "standing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8", "standing_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8", "standing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8", "star": "https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8", "star2": "https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8", "star_and_crescent": "https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8", "star_of_david": "https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8", "star_struck": "https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8", "stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8", "station": "https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8", "statue_of_liberty": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8", "steam_locomotive": "https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8", "stethoscope": "https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8", "stew": "https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8", "stop_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8", "stop_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8", "stopwatch": "https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8", "straight_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8", "strawberry": "https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8", "stuck_out_tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8", "stuck_out_tongue_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8", "stuck_out_tongue_winking_eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8", "student": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8", "studio_microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8", "stuffed_flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8", "sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8", "sun_behind_large_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8", "sun_behind_rain_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8", "sun_behind_small_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8", "sun_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8", "sunflower": "https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8", "sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8", "sunny": "https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8", "sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8", "sunrise_over_mountains": "https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8", "superhero": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8", "superhero_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8", "superhero_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8", "supervillain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8", "supervillain_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8", "supervillain_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8", "surfer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8", "surfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8", "surfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8", "suriname": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8", "sushi": "https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8", "suspect": "https://github.githubassets.com/images/icons/emoji/suspect.png?v8", "suspension_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8", "svalbard_jan_mayen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8", "swan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8", "swaziland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8", "sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8", "sweat_drops": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8", "sweat_smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8", "sweden": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8", "sweet_potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8", "swim_brief": "https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8", "swimmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8", "swimming_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8", "swimming_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8", "switzerland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8", "symbols": "https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8", "synagogue": "https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8", "syria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8", "syringe": "https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8", "t-rex": "https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8", "taco": "https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8", "tada": "https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8", "taiwan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8", "tajikistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8", "takeout_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8", "tamale": "https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8", "tanabata_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8", "tangerine": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", "tanzania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8", "taurus": "https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8", "taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8", "tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8", "teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8", "teapot": "https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8", "technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8", "teddy_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8", "telephone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", "telephone_receiver": "https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8", "telescope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8", "tennis": "https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8", "tent": "https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8", "test_tube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8", "thailand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8", "thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8", "thinking": "https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8", "thong_sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8", "thought_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8", "thread": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8", "three": "https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8", "thumbsdown": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", "thumbsup": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", "ticket": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8", "tickets": "https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8", "tiger": "https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8", "tiger2": "https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8", "timer_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8", "timor_leste": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8", "tipping_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", "tipping_hand_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", "tipping_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", "tired_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8", "tm": "https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8", "togo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8", "toilet": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8", "tokelau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8", "tokyo_tower": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8", "tomato": "https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8", "tonga": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8", "tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8", "toolbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8", "tooth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8", "toothbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8", "top": "https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8", "tophat": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8", "tornado": "https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8", "tr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8", "trackball": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8", "tractor": "https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8", "traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8", "train": "https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8", "train2": "https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8", "tram": "https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8", "transgender_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8", "transgender_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8", "triangular_flag_on_post": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8", "triangular_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8", "trident": "https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8", "trinidad_tobago": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8", "tristan_da_cunha": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8", "triumph": "https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8", "trolleybus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8", "trollface": "https://github.githubassets.com/images/icons/emoji/trollface.png?v8", "trophy": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8", "tropical_drink": "https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8", "tropical_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8", "truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8", "trumpet": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8", "tshirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", "tulip": "https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8", "tumbler_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8", "tunisia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8", "turkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8", "turkmenistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8", "turks_caicos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8", "turtle": "https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8", "tuvalu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8", "tv": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8", "twisted_rightwards_arrows": "https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8", "two": "https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8", "two_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8", "two_men_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8", "two_women_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8", "u5272": "https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8", "u5408": "https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8", "u55b6": "https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8", "u6307": "https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8", "u6708": "https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8", "u6709": "https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8", "u6e80": "https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8", "u7121": "https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8", "u7533": "https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8", "u7981": "https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8", "u7a7a": "https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8", "uganda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8", "uk": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", "ukraine": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8", "umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8", "unamused": "https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8", "underage": "https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8", "unicorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8", "united_arab_emirates": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8", "united_nations": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8", "unlock": "https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8", "up": "https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8", "upside_down_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8", "uruguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8", "us": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8", "us_outlying_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8", "us_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8", "uzbekistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8", "v": "https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8", "vampire": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8", "vampire_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8", "vampire_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8", "vanuatu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8", "vatican_city": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8", "venezuela": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8", "vertical_traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8", "vhs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8", "vibration_mode": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8", "video_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8", "video_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8", "vietnam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8", "violin": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8", "virgo": "https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8", "volcano": "https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8", "volleyball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8", "vomiting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8", "vs": "https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8", "vulcan_salute": "https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8", "waffle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8", "wales": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8", "walking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8", "walking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8", "walking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8", "wallis_futuna": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8", "waning_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8", "waning_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8", "warning": "https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8", "wastebasket": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8", "watch": "https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8", "water_buffalo": "https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8", "water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8", "watermelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8", "wave": "https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8", "wavy_dash": "https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8", "waxing_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8", "waxing_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", "wc": "https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8", "weary": "https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8", "wedding": "https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8", "weight_lifting": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8", "weight_lifting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8", "weight_lifting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8", "western_sahara": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8", "whale": "https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8", "whale2": "https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8", "wheel_of_dharma": "https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8", "wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8", "white_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8", "white_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8", "white_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8", "white_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8", "white_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8", "white_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8", "white_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8", "white_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8", "white_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8", "white_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8", "white_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8", "white_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8", "wilted_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8", "wind_chime": "https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8", "wind_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8", "window": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8", "wine_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8", "wink": "https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8", "wolf": "https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8", "woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8", "woman_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8", "woman_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8", "woman_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8", "woman_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8", "woman_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8", "woman_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", "woman_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8", "woman_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8", "woman_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8", "woman_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8", "woman_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8", "woman_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8", "woman_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8", "woman_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8", "woman_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8", "woman_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8", "woman_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8", "woman_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8", "woman_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8", "woman_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8", "woman_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8", "woman_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8", "woman_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8", "woman_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8", "woman_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8", "woman_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8", "woman_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8", "woman_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8", "woman_with_headscarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8", "woman_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8", "woman_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8", "woman_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", "womans_clothes": "https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8", "womans_hat": "https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8", "women_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8", "womens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8", "wood": "https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8", "woozy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8", "world_map": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8", "worm": "https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8", "worried": "https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8", "wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8", "wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8", "writing_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8", "x": "https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8", "yarn": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8", "yawning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8", "yellow_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8", "yellow_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8", "yellow_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8", "yemen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8", "yen": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8", "yin_yang": "https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8", "yo_yo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8", "yum": "https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8", "zambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8", "zany_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8", "zap": "https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8", "zebra": "https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8", "zero": "https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8", "zimbabwe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8", "zipper_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8", "zombie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8", "zombie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8", "zombie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8", "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" } } } } }, "description": "Response" }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "emojis", "subcategory": "emojis" }, "x-octokit": {} } }, "/enterprises/{enterprise}/actions/cache/retention-limit": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/get-actions-cache-retention-limit-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Actions cache retention limit for an enterprise", "description": "GitHub Actions cache retention policy for an enterprise.", "type": "object", "properties": { "max_cache_retention_days": { "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", "type": "integer", "example": 14 } } }, "examples": { "default": { "value": { "max_cache_retention_days": 80 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} }, "put": { "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.", "tags": [ "actions" ], "operationId": "actions/set-actions-cache-retention-limit-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "Actions cache retention limit for an enterprise", "description": "GitHub Actions cache retention policy for an enterprise.", "type": "object", "properties": { "max_cache_retention_days": { "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", "type": "integer", "example": 14 } } }, "examples": { "selected_actions": { "value": { "max_cache_retention_days": 80 } } } } } }, "responses": { "204": { "description": "Response" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} } }, "/enterprises/{enterprise}/actions/cache/storage-limit": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/get-actions-cache-storage-limit-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Actions cache storage limit for an enterprise", "description": "GitHub Actions cache storage policy for an enterprise.", "type": "object", "properties": { "max_cache_size_gb": { "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", "type": "integer", "example": 10 } } }, "examples": { "default": { "value": { "max_cache_size_gb": 150 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} }, "put": { "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.", "tags": [ "actions" ], "operationId": "actions/set-actions-cache-storage-limit-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "Actions cache storage limit for an enterprise", "description": "GitHub Actions cache storage policy for an enterprise.", "type": "object", "properties": { "max_cache_size_gb": { "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", "type": "integer", "example": 10 } } }, "examples": { "selected_actions": { "value": { "max_cache_size_gb": 150 } } } } } }, "responses": { "204": { "description": "Response" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} } }, "/enterprises/{enterprise}/code-security/configurations": { "get": { "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.", "tags": [ "code-security" ], "operationId": "code-security/get-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "required": false, "schema": { "type": "integer", "default": 30 } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "examples": { "default": { "value": [ { "id": 17, "target_type": "global", "name": "GitHub recommended", "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "enabled", "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", "created_at": "2023-12-04T15:58:07Z", "updated_at": "2023-12-04T15:58:07Z" }, { "id": 1326, "target_type": "enterprise", "name": "High risk settings", "description": "This is a code security configuration for octo-enterprise high risk repositories", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "enabled", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", "created_at": "2024-05-10T00:00:00Z", "updated_at": "2024-05-10T00:00:00Z" } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} }, "post": { "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.", "tags": [ "code-security" ], "operationId": "code-security/create-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the enterprise." }, "description": { "type": "string", "description": "A description of the code security configuration", "maxLength": 255 }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\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" ], "default": "disabled" }, "code_security": { "type": "string", "description": "The enablement status of GitHub Code Security features.", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ], "default": "enabled" }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", "default": false } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "code_scanning_options": { "type": "object", "description": "Security Configuration feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_protection": { "type": "string", "description": "The enablement status of GitHub Secret Protection features.", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non provider patterns", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ], "default": "enforced" } }, "required": [ "name", "description" ] }, "examples": { "default": { "summary": "Example for a code security configuration", "value": { "name": "High rish settings", "description": "This is a code security configuration for octo-enterprise", "advanced_security": "enabled", "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "secret_scanning": "enabled" } } } } } }, "responses": { "201": { "description": "Successfully created code security configuration", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "enterprise", "name": "High risk settings", "description": "This is a code security configuration for octo-enterprise", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_generic_secrets": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/code-security/configurations/defaults": { "get": { "summary": "Get default code security configurations for an enterprise", "description": "Lists the default code security configurations for an enterprise.\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.", "tags": [ "code-security" ], "operationId": "code-security/get-default-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "description": "A list of default code security configurations", "items": { "type": "object", "properties": { "default_for_new_repos": { "enum": [ "public", "private_and_internal", "all" ], "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" }, "configuration": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "examples": { "default": { "value": [ { "default_for_new_repos": "public", "configuration": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", "secret_scanning_delegated_bypass_options": { "reviewers": [ { "security_configuration_id": 1325, "reviewer_id": 5678, "reviewer_type": "TEAM" } ] }, "secret_scanning_validity_checks": "enabled", "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } }, { "default_for_new_repos": "private_and_internal", "configuration": { "id": 17, "target_type": "global", "name": "GitHub recommended", "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", "updated_at": "2023-12-04T15:58:07Z" } } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { "get": { "summary": "Retrieve a code security configuration of an enterprise", "description": "Gets a code security configuration available in an enterprise.\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.", "tags": [ "code-security" ], "operationId": "code-security/get-single-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "enterprise", "name": "High risk settings", "description": "This is a code security configuration for octo-enterprise", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_generic_secrets": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} }, "patch": { "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.", "tags": [ "code-security" ], "operationId": "code-security/update-enterprise-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the code security configuration. Must be unique across the enterprise." }, "description": { "type": "string", "description": "A description of the code security configuration", "maxLength": 255 }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\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_security": { "type": "string", "description": "The enablement status of GitHub Code Security features.", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_protection": { "type": "string", "description": "The enablement status of GitHub Secret Protection features.", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] } } }, "examples": { "default": { "summary": "Example for updating a code security configuration", "value": { "name": "octo-enterprise recommended settings v2", "secret_scanning": "disabled", "code_scanning_default_setup": "enabled" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "enterprise", "name": "High risk settings", "description": "This is a code security configuration for octo-enterprise", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_generic_secrets": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "code-security" ], "operationId": "code-security/delete-configuration-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "A header with no content is returned." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { "post": { "summary": "Attach an enterprise configuration to repositories", "description": "Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\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.", "tags": [ "code-security" ], "operationId": "code-security/attach-enterprise-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "scope": { "type": "string", "description": "The type of repositories to attach the configuration to.", "enum": [ "all", "all_without_configurations" ] } }, "required": [ "scope" ] }, "examples": { "default": { "summary": "Example for attaching a configuration to some repositories", "value": { "scope": "all" } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "default": { "value": null } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { "put": { "summary": "Set a code security configuration as a default for an enterprise", "description": "Sets a code security configuration as a default to be applied to new repositories in your enterprise.\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.", "tags": [ "code-security" ], "operationId": "code-security/set-configuration-as-default-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "default_for_new_repos": { "type": "string", "description": "Specify which types of repository this security configuration should be applied to by default.", "enum": [ "all", "none", "private_and_internal", "public" ] } } }, "examples": { "default": { "summary": "Set this configuration to be enabled by default on all new repositories.", "value": { "default_for_new_repos": "all" } } } } } }, "responses": { "200": { "description": "Default successfully changed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "default_for_new_repos": { "type": "string", "description": "Specifies which types of repository this security configuration is applied to by default.", "enum": [ "all", "none", "private_and_internal", "public" ] }, "configuration": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } }, "examples": { "default": { "value": { "default_for_new_repos": "all", "configuration": { "value": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_generic_secrets": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { "get": { "summary": "Get repositories associated with an enterprise code security configuration", "description": "Lists the repositories associated with an enterprise code security configuration in an organization.\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.", "tags": [ "code-security" ], "operationId": "code-security/get-repositories-for-enterprise-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "integer", "default": 30 } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "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`", "in": "query", "required": false, "schema": { "type": "string", "default": "all" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Repositories associated with a code security configuration and attachment status", "properties": { "status": { "type": "string", "description": "The attachment status of the code security configuration on the repository.", "enum": [ "attached", "attaching", "detached", "removed", "enforced", "failed", "updating", "removed_by_enterprise" ] }, "repository": { "title": "Simple Repository", "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", "example": "Hello-World", "description": "The name of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", "nullable": true, "description": "The repository description." }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World", "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/contributors", "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/downloads", "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/events", "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/forks", "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/languages", "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/merges", "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscription", "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/tags", "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/teams", "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks", "description": "The API URL to list the hooks on the repository." } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } }, "examples": { "default": { "summary": "Example of code security configuration repositories", "value": [ { "status": "attached", "repository": { "value": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } } } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\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.", "tags": [ "dependabot" ], "operationId": "dependabot/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "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" } }, { "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" } }, { "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" } }, { "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" } }, { "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- 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" } }, { "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": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "enum": [ "patch" ] } } ] } }, { "name": "scope", "in": "query", "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", "schema": { "type": "string", "enum": [ "development", "runtime" ] } }, { "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", "enum": [ "created", "updated", "epss_percentage" ], "default": "created" } }, { "name": "direction", "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "A Dependabot alert.", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "state": { "type": "string", "description": "The state of the Dependabot alert.", "readOnly": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, "dependency": { "type": "object", "description": "Details for the vulnerable dependency.", "readOnly": true, "properties": { "package": { "type": "object", "description": "Details for the vulnerable package.", "readOnly": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "readOnly": true }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "required": [ "ecosystem", "name" ], "additionalProperties": false }, "manifest_path": { "type": "string", "description": "The full path to the dependency manifest file, relative to the root of the repository.", "readOnly": true }, "scope": { "type": "string", "description": "The execution scope of the vulnerable dependency.", "readOnly": true, "nullable": true, "enum": [ "development", "runtime" ] }, "relationship": { "type": "string", "description": "The vulnerable dependency's relationship to your project.\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.\n", "readOnly": true, "nullable": true, "enum": [ "unknown", "direct", "transitive" ] } } }, "security_advisory": { "type": "object", "description": "Details for the GitHub Security Advisory.", "readOnly": true, "properties": { "ghsa_id": { "type": "string", "description": "The unique GitHub Security Advisory ID assigned to the advisory.", "readOnly": true }, "cve_id": { "type": "string", "description": "The unique CVE ID assigned to the advisory.", "readOnly": true, "nullable": true }, "summary": { "type": "string", "description": "A short, plain text summary of the advisory.", "readOnly": true, "maxLength": 1024 }, "description": { "type": "string", "description": "A long-form Markdown-supported description of the advisory.", "readOnly": true }, "vulnerabilities": { "type": "array", "description": "Vulnerable version range information for the advisory.", "readOnly": true, "items": { "type": "object", "description": "Details pertaining to one vulnerable version range for the advisory.", "readOnly": true, "properties": { "package": { "type": "object", "description": "Details for the vulnerable package.", "readOnly": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "readOnly": true }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "required": [ "ecosystem", "name" ], "additionalProperties": false }, "severity": { "type": "string", "description": "The severity of the vulnerability.", "readOnly": true, "enum": [ "low", "medium", "high", "critical" ] }, "vulnerable_version_range": { "type": "string", "description": "Conditions that identify vulnerable versions of this vulnerability's package.", "readOnly": true }, "first_patched_version": { "type": "object", "description": "Details pertaining to the package version that patches this vulnerability.", "readOnly": true, "nullable": true, "properties": { "identifier": { "type": "string", "description": "The package version that patches this vulnerability.", "readOnly": true } }, "required": [ "identifier" ], "additionalProperties": false } }, "required": [ "package", "severity", "vulnerable_version_range", "first_patched_version" ], "additionalProperties": false } }, "severity": { "type": "string", "description": "The severity of the advisory.", "readOnly": true, "enum": [ "low", "medium", "high", "critical" ] }, "cvss": { "type": "object", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", "readOnly": true, "properties": { "score": { "type": "number", "description": "The overall CVSS score of the advisory.", "minimum": 0, "maximum": 10, "readOnly": true }, "vector_string": { "type": "string", "description": "The full CVSS vector string for the advisory.", "readOnly": true, "nullable": true } }, "required": [ "score", "vector_string" ], "additionalProperties": false }, "cvss_severities": { "type": "object", "nullable": true, "properties": { "cvss_v3": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 3 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 3 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_v4": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 4 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 4 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] } } }, "epss": { "type": "object", "nullable": true, "readOnly": true, "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", "properties": { "percentage": { "type": "number", "minimum": 0, "maximum": 100 }, "percentile": { "type": "number", "minimum": 0, "maximum": 100 } } }, "cwes": { "type": "array", "description": "Details for the advisory pertaining to Common Weakness Enumeration.", "readOnly": true, "items": { "type": "object", "description": "A CWE weakness assigned to the advisory.", "readOnly": true, "properties": { "cwe_id": { "type": "string", "description": "The unique CWE ID.", "readOnly": true }, "name": { "type": "string", "description": "The short, plain text name of the CWE.", "readOnly": true } }, "required": [ "cwe_id", "name" ], "additionalProperties": false } }, "identifiers": { "type": "array", "description": "Values that identify this advisory among security information sources.", "readOnly": true, "items": { "type": "object", "description": "An advisory identifier.", "readOnly": true, "properties": { "type": { "type": "string", "description": "The type of advisory identifier.", "readOnly": true, "enum": [ "CVE", "GHSA" ] }, "value": { "type": "string", "description": "The value of the advisory identifer.", "readOnly": true } }, "required": [ "value", "type" ], "additionalProperties": false } }, "references": { "type": "array", "description": "Links to additional advisory information.", "readOnly": true, "items": { "type": "object", "description": "A link to additional advisory information.", "readOnly": true, "properties": { "url": { "type": "string", "description": "The URL of the reference.", "format": "uri", "readOnly": true } }, "required": [ "url" ], "additionalProperties": false } }, "published_at": { "type": "string", "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "withdrawn_at": { "type": "string", "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true } }, "required": [ "ghsa_id", "cve_id", "summary", "description", "vulnerabilities", "severity", "cvss", "cwes", "identifiers", "references", "published_at", "updated_at", "withdrawn_at" ], "additionalProperties": false }, "security_vulnerability": { "type": "object", "description": "Details pertaining to one vulnerable version range for the advisory.", "readOnly": true, "properties": { "package": { "type": "object", "description": "Details for the vulnerable package.", "readOnly": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "readOnly": true }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "required": [ "ecosystem", "name" ], "additionalProperties": false }, "severity": { "type": "string", "description": "The severity of the vulnerability.", "readOnly": true, "enum": [ "low", "medium", "high", "critical" ] }, "vulnerable_version_range": { "type": "string", "description": "Conditions that identify vulnerable versions of this vulnerability's package.", "readOnly": true }, "first_patched_version": { "type": "object", "description": "Details pertaining to the package version that patches this vulnerability.", "readOnly": true, "nullable": true, "properties": { "identifier": { "type": "string", "description": "The package version that patches this vulnerability.", "readOnly": true } }, "required": [ "identifier" ], "additionalProperties": false } }, "required": [ "package", "severity", "vulnerable_version_range", "first_patched_version" ], "additionalProperties": false }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_at": { "type": "string", "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true }, "dismissed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "dismissed_reason": { "type": "string", "description": "The reason that the alert was dismissed.", "nullable": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk" ] }, "dismissed_comment": { "type": "string", "description": "An optional comment associated with the alert's dismissal.", "nullable": true, "maxLength": 280 }, "fixed_at": { "type": "string", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true }, "auto_dismissed_at": { "type": "string", "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true }, "dismissal_request": { "title": "Dependabot alert dismissal request", "description": "Information about an active dismissal request for this Dependabot alert.", "type": "object", "nullable": true, "properties": { "id": { "type": "integer", "description": "The unique identifier of the dismissal request." }, "status": { "type": "string", "description": "The current status of the dismissal request.", "enum": [ "pending", "approved", "rejected", "cancelled" ] }, "requester": { "type": "object", "description": "The user who requested the dismissal.", "properties": { "id": { "type": "integer", "description": "The unique identifier of the user." }, "login": { "type": "string", "description": "The login name of the user." } } }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time when the dismissal request was created." }, "url": { "type": "string", "format": "uri", "description": "The API URL to get more information about this dismissal request." } } }, "repository": { "title": "Simple Repository", "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", "example": "Hello-World", "description": "The name of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", "nullable": true, "description": "The repository description." }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World", "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/contributors", "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/downloads", "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/events", "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/forks", "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/languages", "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/merges", "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscription", "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/tags", "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/teams", "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks", "description": "The API URL to list the hooks on the repository." } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } }, "required": [ "number", "state", "dependency", "security_advisory", "security_vulnerability", "url", "html_url", "created_at", "updated_at", "dismissed_at", "dismissed_by", "dismissed_reason", "dismissed_comment", "fixed_at", "repository" ], "additionalProperties": false } }, "examples": { "default": { "value": [ { "number": 2, "state": "dismissed", "dependency": { "package": { "ecosystem": "pip", "name": "django" }, "manifest_path": "path/to/requirements.txt", "scope": "runtime" }, "security_advisory": { "ghsa_id": "GHSA-rf4j-j272-fj86", "cve_id": "CVE-2018-6188", "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", "vulnerabilities": [ { "package": { "ecosystem": "pip", "name": "django" }, "severity": "high", "vulnerable_version_range": ">= 2.0.0, < 2.0.2", "first_patched_version": { "identifier": "2.0.2" } }, { "package": { "ecosystem": "pip", "name": "django" }, "severity": "high", "vulnerable_version_range": ">= 1.11.8, < 1.11.10", "first_patched_version": { "identifier": "1.11.10" } } ], "severity": "high", "cvss": { "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, "cvss_v4": { "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", "score": 8.7 } }, "epss": [ { "percentage": 0.00045, "percentile": "0.16001e0" } ], "cwes": [ { "cwe_id": "CWE-200", "name": "Exposure of Sensitive Information to an Unauthorized Actor" } ], "identifiers": [ { "type": "GHSA", "value": "GHSA-rf4j-j272-fj86" }, { "type": "CVE", "value": "CVE-2018-6188" } ], "references": [ { "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" }, { "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" }, { "url": "https://usn.ubuntu.com/3559-1/" }, { "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" }, { "url": "http://www.securitytracker.com/id/1040422" } ], "published_at": "2018-10-03T21:13:54Z", "updated_at": "2022-04-26T18:35:37Z", "withdrawn_at": null }, "security_vulnerability": { "package": { "ecosystem": "pip", "name": "django" }, "severity": "high", "vulnerable_version_range": ">= 2.0.0, < 2.0.2", "first_patched_version": { "identifier": "2.0.2" } }, "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", "created_at": "2022-06-15T07:43:03Z", "updated_at": "2022-08-23T14:29:47Z", "dismissed_at": "2022-08-23T14:29:47Z", "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "dismissed_reason": "tolerable_risk", "dismissed_comment": "This alert is accurate but we use a sanitizer.", "fixed_at": null, "repository": { "id": 217723378, "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", "name": "octo-repo", "full_name": "octo-org/octo-repo", "owner": { "login": "octo-org", "id": 6811672, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octo-org", "html_url": "https://github.com/octo-org", "followers_url": "https://api.github.com/users/octo-org/followers", "following_url": "https://api.github.com/users/octo-org/following{/other_user}", "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", "organizations_url": "https://api.github.com/users/octo-org/orgs", "repos_url": "https://api.github.com/users/octo-org/repos", "events_url": "https://api.github.com/users/octo-org/events{/privacy}", "received_events_url": "https://api.github.com/users/octo-org/received_events", "type": "Organization", "site_admin": false }, "private": true, "html_url": "https://github.com/octo-org/octo-repo", "description": null, "fork": false, "url": "https://api.github.com/repos/octo-org/octo-repo", "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" } }, { "number": 1, "state": "open", "dependency": { "package": { "ecosystem": "pip", "name": "ansible" }, "manifest_path": "path/to/requirements.txt", "scope": "runtime" }, "security_advisory": { "ghsa_id": "GHSA-8f4m-hccc-8qph", "cve_id": "CVE-2021-20191", "summary": "Insertion of Sensitive Information into Log File in ansible", "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", "vulnerabilities": [ { "package": { "ecosystem": "pip", "name": "ansible" }, "severity": "medium", "vulnerable_version_range": ">= 2.9.0, < 2.9.18", "first_patched_version": { "identifier": "2.9.18" } }, { "package": { "ecosystem": "pip", "name": "ansible" }, "severity": "medium", "vulnerable_version_range": "< 2.8.19", "first_patched_version": { "identifier": "2.8.19" } }, { "package": { "ecosystem": "pip", "name": "ansible" }, "severity": "medium", "vulnerable_version_range": ">= 2.10.0, < 2.10.7", "first_patched_version": { "identifier": "2.10.7" } } ], "severity": "medium", "cvss": { "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, "cvss_v4": { "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", "score": 8.5 } }, "cwes": [ { "cwe_id": "CWE-532", "name": "Insertion of Sensitive Information into Log File" } ], "identifiers": [ { "type": "GHSA", "value": "GHSA-8f4m-hccc-8qph" }, { "type": "CVE", "value": "CVE-2021-20191" } ], "references": [ { "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" }, { "url": "https://access.redhat.com/security/cve/cve-2021-20191" }, { "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" } ], "published_at": "2021-06-01T17:38:00Z", "updated_at": "2021-08-12T23:06:00Z", "withdrawn_at": null }, "security_vulnerability": { "package": { "ecosystem": "pip", "name": "ansible" }, "severity": "medium", "vulnerable_version_range": "< 2.8.19", "first_patched_version": { "identifier": "2.8.19" } }, "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", "created_at": "2022-06-14T15:21:52Z", "updated_at": "2022-06-14T15:21:52Z", "dismissed_at": null, "dismissed_by": null, "dismissed_reason": null, "dismissed_comment": null, "fixed_at": null, "repository": { "id": 664700648, "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", "name": "hello-world", "full_name": "octo-org/hello-world", "owner": { "login": "octo-org", "id": 6811672, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octo-org", "html_url": "https://github.com/octo-org", "followers_url": "https://api.github.com/users/octo-org/followers", "following_url": "https://api.github.com/users/octo-org/following{/other_user}", "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", "organizations_url": "https://api.github.com/users/octo-org/orgs", "repos_url": "https://api.github.com/users/octo-org/repos", "events_url": "https://api.github.com/users/octo-org/events{/privacy}", "received_events_url": "https://api.github.com/users/octo-org/received_events", "type": "Organization", "site_admin": false }, "private": true, "html_url": "https://github.com/octo-org/hello-world", "description": null, "fork": false, "url": "https://api.github.com/repos/octo-org/hello-world", "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", "events_url": "https://api.github.com/repos/octo-org/hello-world/events", "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" } } ] } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [], "category": "dependabot", "subcategory": "alerts" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams": { "get": { "summary": "List enterprise teams", "description": "List all teams in the enterprise for the authenticated user", "tags": [ "enterprise-teams" ], "operationId": "enterprise-teams/list", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "sync_to_organizations": { "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "disabled | all" }, "organization_selection_type": { "type": "string", "example": "disabled | selected | all" }, "group_id": { "nullable": true, "type": "string", "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, "group_name": { "nullable": true, "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "Justice League" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/dc/teams/justice-league" }, "members_url": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "members_url", "name", "html_url", "slug", "created_at", "updated_at", "group_id" ] } }, "examples": { "default": { "value": [ { "id": 1, "name": "Justice League", "description": "A great team.", "slug": "justice-league", "url": "https://api.github.com/enterprises/dc/teams/justice-league", "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", "html_url": "https://github.com/enterprises/dc/teams/justice-league", "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", "created_at": "2019-01-26T19:01:12Z", "updated_at": "2019-01-26T19:14:43Z" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-teams" }, "x-octokit": {} }, "post": { "summary": "Create an enterprise team", "description": "To create an enterprise team, the authenticated user must be an owner of the enterprise.", "tags": [ "enterprise-teams" ], "operationId": "enterprise-teams/create", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the team." }, "description": { "nullable": true, "type": "string", "description": "A description of the team." }, "sync_to_organizations": { "type": "string", "description": "Retired: this field is no longer supported.\nWhether the enterprise team should be reflected in each organization.\nThis value cannot be set.\n", "enum": [ "all", "disabled" ], "default": "disabled" }, "organization_selection_type": { "type": "string", "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\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" ], "default": "disabled" }, "group_id": { "nullable": true, "type": "string", "description": "The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise)." } }, "required": [ "name" ] }, "examples": { "default": { "value": { "name": "Justice League", "description": "A great team.", "group_id": "62ab9291-fae2-468e-974b-7e45096d5021" } } } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "sync_to_organizations": { "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "disabled | all" }, "organization_selection_type": { "type": "string", "example": "disabled | selected | all" }, "group_id": { "nullable": true, "type": "string", "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, "group_name": { "nullable": true, "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "Justice League" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/dc/teams/justice-league" }, "members_url": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "members_url", "name", "html_url", "slug", "created_at", "updated_at", "group_id" ] }, "examples": { "default": { "value": [ { "id": 1, "name": "Justice League", "description": "A great team.", "slug": "justice-league", "url": "https://api.github.com/enterprises/dc/teams/justice-league", "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", "html_url": "https://github.com/enterprises/dc/teams/justice-league", "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", "created_at": "2019-01-26T19:01:12Z", "updated_at": "2019-01-26T19:14:43Z" } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-teams" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": { "get": { "summary": "List members in an enterprise team", "description": "Lists all team members in an enterprise team.", "tags": [ "enterprise-team-memberships" ], "operationId": "enterprise-team-memberships/list", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "examples": { "default": { "value": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-members" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": { "post": { "summary": "Bulk add team members", "description": "Add multiple team members to an enterprise team.", "tags": [ "enterprise-team-memberships" ], "operationId": "enterprise-team-memberships/bulk-add", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "usernames" ], "properties": { "usernames": { "type": "array", "description": "The GitHub user handles to add to the team.", "items": { "type": "string", "description": "The handle for the GitHub user account." } } } }, "examples": { "default": { "value": { "usernames": [ "monalisa", "octocat" ] } } } } } }, "responses": { "200": { "description": "Successfully added team members.", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "examples": { "default": { "value": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-members" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": { "post": { "summary": "Bulk remove team members", "description": "Remove multiple team members from an enterprise team.", "tags": [ "enterprise-team-memberships" ], "operationId": "enterprise-team-memberships/bulk-remove", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "usernames" ], "properties": { "usernames": { "type": "array", "description": "The GitHub user handles to be removed from the team.", "items": { "type": "string", "description": "The handle for the GitHub user account." } } } }, "examples": { "default": { "value": { "usernames": [ "monalisa", "octocat" ] } } } } } }, "responses": { "200": { "description": "Successfully removed team members.", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "examples": { "default": { "value": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-members" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": { "get": { "summary": "Get enterprise team membership", "description": "Returns whether the user is a member of the enterprise team.", "tags": [ "enterprise-team-memberships" ], "operationId": "enterprise-team-memberships/get", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User is a member of the enterprise team.", "content": { "application/json": { "schema": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "examples": { "exampleKey1": { "value": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-members" }, "x-octokit": {} }, "put": { "summary": "Add team member", "description": "Add a team member to an enterprise team.", "tags": [ "enterprise-team-memberships" ], "operationId": "enterprise-team-memberships/add", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successfully added team member", "content": { "application/json": { "schema": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "examples": { "exampleKey1": { "value": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-members" }, "x-octokit": {} }, "delete": { "summary": "Remove team membership", "description": "Remove membership of a specific user from a particular team in an enterprise.", "tags": [ "enterprise-team-memberships" ], "operationId": "enterprise-team-memberships/remove", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-members" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { "get": { "summary": "Get organization assignments", "description": "Get all organizations assigned to an enterprise team", "tags": [ "enterprise-team-organizations" ], "operationId": "enterprise-team-organizations/get-assignments", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "An array of organizations the team is assigned to", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Organization Simple", "description": "A GitHub organization.", "type": "object", "properties": { "login": { "type": "string", "example": "github" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/repos" }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/events" }, "hooks_url": { "type": "string", "example": "https://api.github.com/orgs/github/hooks" }, "issues_url": { "type": "string", "example": "https://api.github.com/orgs/github/issues" }, "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, "public_members_url": { "type": "string", "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" }, "description": { "type": "string", "example": "A great organization", "nullable": true } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] } }, "examples": { "default": { "value": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-organizations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { "post": { "summary": "Add organization assignments", "description": "Assign an enterprise team to multiple organizations.", "tags": [ "enterprise-team-organizations" ], "operationId": "enterprise-team-organizations/bulk-add", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "organization_slugs" ], "properties": { "organization_slugs": { "type": "array", "description": "Organization slug to assign the team to.", "items": { "type": "string", "description": "Organization slug to assign the team to" } } } }, "examples": { "default": { "value": { "organization_slugs": [ "github" ] } } } } } }, "responses": { "200": { "description": "Successfully assigned the enterprise team to organizations.", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Organization Simple", "description": "A GitHub organization.", "type": "object", "properties": { "login": { "type": "string", "example": "github" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/repos" }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/events" }, "hooks_url": { "type": "string", "example": "https://api.github.com/orgs/github/hooks" }, "issues_url": { "type": "string", "example": "https://api.github.com/orgs/github/issues" }, "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, "public_members_url": { "type": "string", "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" }, "description": { "type": "string", "example": "A great organization", "nullable": true } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] } }, "examples": { "default": { "value": [ { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-organizations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { "post": { "summary": "Remove organization assignments", "description": "Unassign an enterprise team from multiple organizations.", "tags": [ "enterprise-team-organizations" ], "operationId": "enterprise-team-organizations/bulk-remove", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "organization_slugs" ], "properties": { "organization_slugs": { "type": "array", "description": "Organization slug to unassign the team from.", "items": { "type": "string", "description": "Organization slug to unassign the team from" } } } }, "examples": { "default": { "value": { "organization_slugs": [ "github" ] } } } } } }, "responses": { "204": { "description": "Successfully unassigned the enterprise team from organizations." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-organizations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { "get": { "summary": "Get organization assignment", "description": "Check if an enterprise team is assigned to an organization", "tags": [ "enterprise-team-organizations" ], "operationId": "enterprise-team-organizations/get-assignment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The team is assigned to the organization", "content": { "application/json": { "schema": { "title": "Organization Simple", "description": "A GitHub organization.", "type": "object", "properties": { "login": { "type": "string", "example": "github" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/repos" }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/events" }, "hooks_url": { "type": "string", "example": "https://api.github.com/orgs/github/hooks" }, "issues_url": { "type": "string", "example": "https://api.github.com/orgs/github/issues" }, "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, "public_members_url": { "type": "string", "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" }, "description": { "type": "string", "example": "A great organization", "nullable": true } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] }, "examples": { "default": { "value": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } } } } } }, "404": { "description": "The team is not assigned to the organization" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-organizations" }, "x-octokit": {} }, "put": { "summary": "Add an organization assignment", "description": "Assign an enterprise team to an organization.", "tags": [ "enterprise-team-organizations" ], "operationId": "enterprise-team-organizations/add", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successfully assigned the enterprise team to the organization.", "content": { "application/json": { "schema": { "title": "Organization Simple", "description": "A GitHub organization.", "type": "object", "properties": { "login": { "type": "string", "example": "github" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/repos" }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/events" }, "hooks_url": { "type": "string", "example": "https://api.github.com/orgs/github/hooks" }, "issues_url": { "type": "string", "example": "https://api.github.com/orgs/github/issues" }, "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, "public_members_url": { "type": "string", "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" }, "description": { "type": "string", "example": "A great organization", "nullable": true } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] }, "examples": { "default": { "value": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-organizations" }, "x-octokit": {} }, "delete": { "summary": "Delete an organization assignment", "description": "Unassign an enterprise team from an organization.", "tags": [ "enterprise-team-organizations" ], "operationId": "enterprise-team-organizations/delete", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "enterprise-team", "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully unassigned the enterprise team from the organization." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-team-organizations" }, "x-octokit": {} } }, "/enterprises/{enterprise}/teams/{team_slug}": { "get": { "summary": "Get an enterprise team", "description": "Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the \"ent:\" prefix. For example, \"My TEam Näme\" would become `ent:my-team-name`.", "tags": [ "enterprise-teams" ], "operationId": "enterprise-teams/get", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "sync_to_organizations": { "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "disabled | all" }, "organization_selection_type": { "type": "string", "example": "disabled | selected | all" }, "group_id": { "nullable": true, "type": "string", "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, "group_name": { "nullable": true, "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "Justice League" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/dc/teams/justice-league" }, "members_url": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "members_url", "name", "html_url", "slug", "created_at", "updated_at", "group_id" ] }, "examples": { "default": { "value": [ { "id": 1, "name": "Justice League", "description": "A great team.", "slug": "justice-league", "url": "https://api.github.com/enterprises/dc/teams/justice-league", "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", "html_url": "https://github.com/enterprises/dc/teams/justice-league", "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", "created_at": "2019-01-26T19:01:12Z", "updated_at": "2019-01-26T19:14:43Z" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-teams" }, "x-octokit": {} }, "patch": { "summary": "Update an enterprise team", "description": "To edit a team, the authenticated user must be an enterprise owner.", "tags": [ "enterprise-teams" ], "operationId": "enterprise-teams/update", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "nullable": true, "type": "string", "description": "A new name for the team." }, "description": { "nullable": true, "type": "string", "description": "A new description for the team." }, "sync_to_organizations": { "type": "string", "description": "Retired: this field is no longer supported.\nWhether the enterprise team should be reflected in each organization.\nThis value cannot be changed.\n", "enum": [ "all", "disabled" ], "default": "disabled" }, "organization_selection_type": { "type": "string", "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\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" ], "default": "disabled" }, "group_id": { "nullable": true, "type": "string", "description": "The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group." } } }, "examples": { "default": { "value": { "name": "Justice League", "description": "A great team.", "group_id": "62ab9291-fae2-468e-974b-7e45096d5021" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "sync_to_organizations": { "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "disabled | all" }, "organization_selection_type": { "type": "string", "example": "disabled | selected | all" }, "group_id": { "nullable": true, "type": "string", "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, "group_name": { "nullable": true, "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "Justice League" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/dc/teams/justice-league" }, "members_url": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "members_url", "name", "html_url", "slug", "created_at", "updated_at", "group_id" ] }, "examples": { "default": { "value": [ { "id": 1, "name": "Justice League", "description": "A great team.", "slug": "justice-league", "url": "https://api.github.com/enterprises/dc/teams/justice-league", "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", "html_url": "https://github.com/enterprises/dc/teams/justice-league", "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", "created_at": "2019-01-26T19:01:12Z", "updated_at": "2019-01-26T19:14:43Z" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-teams" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "enterprise-teams" ], "operationId": "enterprise-teams/delete", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team" }, "parameters": [ { "name": "enterprise", "description": "The slug version of the enterprise name.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "team_slug", "description": "The slug of the team name.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "enterprise-teams", "subcategory": "enterprise-teams" }, "x-octokit": {} } }, "/events": { "get": { "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.", "tags": [ "activity" ], "operationId": "activity/list-public-events", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/events#list-public-events" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 15 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "nullable": true }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "oneOf": [ { "title": "CreateEvent", "type": "object", "properties": { "ref": { "type": "string" }, "ref_type": { "type": "string" }, "full_ref": { "type": "string" }, "master_branch": { "type": "string" }, "description": { "type": "string", "nullable": true }, "pusher_type": { "type": "string" } }, "required": [ "ref", "ref_type", "full_ref", "master_branch", "pusher_type" ] }, { "title": "DeleteEvent", "type": "object", "properties": { "ref": { "type": "string" }, "ref_type": { "type": "string" }, "full_ref": { "type": "string" }, "pusher_type": { "type": "string" } }, "required": [ "ref", "ref_type", "full_ref", "pusher_type" ] }, { "title": "DiscussionEvent", "type": "object", "properties": { "action": { "type": "string" }, "discussion": { "title": "Discussion", "description": "A Discussion in a repository.", "type": "object", "properties": { "active_lock_reason": { "type": "string", "nullable": true }, "answer_chosen_at": { "type": "string", "nullable": true }, "answer_chosen_by": { "title": "User", "type": "object", "nullable": true, "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "Bot", "User", "Organization" ] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": [ "login", "id" ] }, "answer_html_url": { "type": "string", "nullable": true }, "author_association": { "title": "AuthorAssociation", "description": "How the author is associated with the repository.", "type": "string", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "body": { "type": "string" }, "category": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "emoji": { "type": "string" }, "id": { "type": "integer" }, "is_answerable": { "type": "boolean" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "repository_id": { "type": "integer" }, "slug": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "repository_id", "emoji", "name", "description", "created_at", "updated_at", "slug", "is_answerable" ] }, "comments": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "html_url": { "type": "string" }, "id": { "type": "integer" }, "locked": { "type": "boolean" }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "reactions": { "title": "Reactions", "type": "object", "properties": { "+1": { "type": "integer" }, "-1": { "type": "integer" }, "confused": { "type": "integer" }, "eyes": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "laugh": { "type": "integer" }, "rocket": { "type": "integer" }, "total_count": { "type": "integer" }, "url": { "type": "string", "format": "uri" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "repository_url": { "type": "string" }, "state": { "type": "string", "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", "enum": [ "open", "closed", "locked", "converting", "transferring" ] }, "state_reason": { "description": "The reason for the current state", "example": "resolved", "type": "string", "nullable": true, "enum": [ "resolved", "outdated", "duplicate", "reopened" ] }, "timeline_url": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "user": { "title": "User", "type": "object", "nullable": true, "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "Bot", "User", "Organization" ] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": [ "login", "id" ] }, "labels": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } }, "required": [ "repository_url", "category", "answer_html_url", "answer_chosen_at", "answer_chosen_by", "html_url", "id", "node_id", "number", "title", "user", "state", "state_reason", "locked", "comments", "created_at", "updated_at", "active_lock_reason", "body" ] } }, "required": [ "action", "discussion" ] }, { "title": "IssuesEvent", "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "example": 42, "type": "integer" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "example": "open", "type": "string" }, "state_reason": { "description": "The reason for the current state", "example": "not_planned", "type": "string", "nullable": true, "enum": [ "completed", "reopened", "not_planned", "duplicate" ] }, "title": { "description": "Title of the issue", "example": "Widget creation fails in Safari on OS X 10.8", "type": "string" }, "body": { "description": "Contents of the issue", "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "example": [ "bug", "registration" ], "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "default": { "type": "boolean" } } } ] } }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "nullable": true }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, "labels_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", "example": 1002604 }, "node_id": { "type": "string", "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { "description": "The number of the milestone.", "type": "integer", "example": 42 }, "state": { "description": "The state of the milestone.", "example": "open", "type": "string", "enum": [ "open", "closed" ], "default": "open" }, "title": { "description": "The title of the milestone.", "example": "v1.0", "type": "string" }, "description": { "type": "string", "example": "Tracking milestone for version 1.0", "nullable": true }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "open_issues": { "type": "integer", "example": 4 }, "closed_issues": { "type": "integer", "example": 8 }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2014-03-03T18:58:10Z" }, "closed_at": { "type": "string", "format": "date-time", "example": "2013-02-12T13:22:01Z", "nullable": true }, "due_on": { "type": "string", "format": "date-time", "example": "2012-10-09T23:39:01Z", "nullable": true } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ], "nullable": true }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": "string", "format": "date-time", "nullable": true }, "diff_url": { "type": "string", "format": "uri", "nullable": true }, "html_url": { "type": "string", "format": "uri", "nullable": true }, "patch_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": "object", "nullable": true, "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": "string", "description": "The description of the issue type.", "nullable": true }, "color": { "type": "string", "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple" ], "nullable": true }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": "string", "format": "uri", "nullable": true }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "IFT_GDKND" }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "example": "text" }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "example": "Sample text" }, { "type": "number", "example": 42.5 }, { "type": "integer", "example": 1 } ], "nullable": true }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, "name": { "description": "The name of the option", "type": "string", "example": "High" }, "color": { "description": "The color of the option", "type": "string", "example": "red" } }, "required": [ "id", "name", "color" ], "nullable": true } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "created_at", "updated_at" ] }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "label": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] }, "labels": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } }, "required": [ "action", "issue" ] }, { "title": "IssueCommentEvent", "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "example": 42, "type": "integer" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "example": "open", "type": "string" }, "state_reason": { "description": "The reason for the current state", "example": "not_planned", "type": "string", "nullable": true, "enum": [ "completed", "reopened", "not_planned", "duplicate" ] }, "title": { "description": "Title of the issue", "example": "Widget creation fails in Safari on OS X 10.8", "type": "string" }, "body": { "description": "Contents of the issue", "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "example": [ "bug", "registration" ], "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "default": { "type": "boolean" } } } ] } }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "nullable": true }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, "labels_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", "example": 1002604 }, "node_id": { "type": "string", "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { "description": "The number of the milestone.", "type": "integer", "example": 42 }, "state": { "description": "The state of the milestone.", "example": "open", "type": "string", "enum": [ "open", "closed" ], "default": "open" }, "title": { "description": "The title of the milestone.", "example": "v1.0", "type": "string" }, "description": { "type": "string", "example": "Tracking milestone for version 1.0", "nullable": true }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "open_issues": { "type": "integer", "example": 4 }, "closed_issues": { "type": "integer", "example": 8 }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2014-03-03T18:58:10Z" }, "closed_at": { "type": "string", "format": "date-time", "example": "2013-02-12T13:22:01Z", "nullable": true }, "due_on": { "type": "string", "format": "date-time", "example": "2012-10-09T23:39:01Z", "nullable": true } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ], "nullable": true }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": "string", "format": "date-time", "nullable": true }, "diff_url": { "type": "string", "format": "uri", "nullable": true }, "html_url": { "type": "string", "format": "uri", "nullable": true }, "patch_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": "object", "nullable": true, "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": "string", "description": "The description of the issue type.", "nullable": true }, "color": { "type": "string", "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple" ], "nullable": true }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": "string", "format": "uri", "nullable": true }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "IFT_GDKND" }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "example": "text" }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "example": "Sample text" }, { "type": "number", "example": 42.5 }, { "type": "integer", "example": 1 } ], "nullable": true }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, "name": { "description": "The name of the option", "type": "string", "example": "High" }, "color": { "description": "The color of the option", "type": "string", "example": "red" } }, "required": [ "id", "name", "color" ], "nullable": true } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, "body": { "description": "Contents of the issue comment", "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-14T16:00:49Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-04-14T16:00:49Z" }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "user", "url", "created_at", "updated_at" ] } }, "required": [ "action", "issue", "comment" ] }, { "title": "ForkEvent", "type": "object", "properties": { "action": { "type": "string" }, "forkee": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "private": { "type": "boolean" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "html_url": { "type": "string" }, "description": { "type": "string", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "keys_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "teams_url": { "type": "string" }, "hooks_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "events_url": { "type": "string" }, "assignees_url": { "type": "string" }, "branches_url": { "type": "string" }, "tags_url": { "type": "string" }, "blobs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "trees_url": { "type": "string" }, "statuses_url": { "type": "string" }, "languages_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "contributors_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "commits_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "comments_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "contents_url": { "type": "string" }, "compare_url": { "type": "string" }, "merges_url": { "type": "string" }, "archive_url": { "type": "string" }, "downloads_url": { "type": "string" }, "issues_url": { "type": "string" }, "pulls_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "labels_url": { "type": "string" }, "releases_url": { "type": "string" }, "deployments_url": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "pushed_at": { "type": "string", "format": "date-time", "nullable": true }, "git_url": { "type": "string" }, "ssh_url": { "type": "string" }, "clone_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "size": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "language": { "type": "string", "nullable": true }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "forks_count": { "type": "integer" }, "mirror_url": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "open_issues_count": { "type": "integer" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "allow_forking": { "type": "boolean" }, "is_template": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "visibility": { "type": "string" }, "forks": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "default_branch": { "type": "string" }, "public": { "type": "boolean" } } } }, "required": [ "action", "forkee" ] }, { "title": "GollumEvent", "type": "object", "properties": { "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } }, "required": [ "pages" ] }, { "title": "MemberEvent", "type": "object", "properties": { "action": { "type": "string" }, "member": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "action", "member" ] }, { "title": "PublicEvent", "type": "object" }, { "title": "PushEvent", "type": "object", "properties": { "repository_id": { "type": "integer" }, "push_id": { "type": "integer" }, "ref": { "type": "string" }, "head": { "type": "string" }, "before": { "type": "string" } }, "required": [ "repository_id", "push_id", "ref", "head", "before" ] }, { "title": "PullRequestEvent", "type": "object", "properties": { "action": { "type": "string" }, "number": { "type": "integer" }, "pull_request": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "label": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] }, "labels": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } }, "required": [ "action", "number", "pull_request" ] }, { "title": "PullRequestReviewCommentEvent", "type": "object", "properties": { "action": { "type": "string" }, "pull_request": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] }, "comment": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "pull_request_review_id": { "type": "integer", "nullable": true }, "diff_hunk": { "type": "string" }, "path": { "type": "string" }, "position": { "type": "integer", "nullable": true }, "original_position": { "type": "integer" }, "subject_type": { "type": "string", "nullable": true }, "commit_id": { "type": "string" }, "user": { "title": "User", "type": "object", "nullable": true, "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "Bot", "User", "Organization" ] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "body": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "html_url": { "type": "string", "format": "uri" }, "pull_request_url": { "type": "string", "format": "uri" }, "_links": { "type": "object", "properties": { "html": { "title": "Link", "type": "object", "properties": { "href": { "type": "string", "format": "uri-template" } }, "required": [ "href" ] }, "pull_request": { "title": "Link", "type": "object", "properties": { "href": { "type": "string", "format": "uri-template" } }, "required": [ "href" ] }, "self": { "title": "Link", "type": "object", "properties": { "href": { "type": "string", "format": "uri-template" } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "original_commit_id": { "type": "string" }, "reactions": { "title": "Reactions", "type": "object", "properties": { "+1": { "type": "integer" }, "-1": { "type": "integer" }, "confused": { "type": "integer" }, "eyes": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "laugh": { "type": "integer" }, "rocket": { "type": "integer" }, "total_count": { "type": "integer" }, "url": { "type": "string", "format": "uri" } } }, "in_reply_to_id": { "type": "integer" } }, "required": [ "url", "pull_request_review_id", "id", "node_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "_links", "reactions" ] } }, "required": [ "action", "comment", "pull_request" ] }, { "title": "PullRequestReviewEvent", "type": "object", "properties": { "action": { "type": "string" }, "review": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "body": { "type": "string" }, "commit_id": { "type": "string" }, "submitted_at": { "type": "string", "nullable": true }, "state": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "pull_request_url": { "type": "string", "format": "uri" }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "updated_at": { "type": "string" } } }, "pull_request": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "required": [ "action", "review", "pull_request" ] }, { "title": "CommitCommentEvent", "type": "object", "properties": { "action": { "type": "string" }, "comment": { "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": "string", "nullable": true }, "position": { "type": "integer", "nullable": true }, "line": { "type": "integer", "nullable": true }, "commit_id": { "type": "string" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } } } }, "required": [ "action", "comment" ] }, { "title": "ReleaseEvent", "type": "object", "properties": { "action": { "type": "string" }, "release": { "allOf": [ { "title": "Release", "description": "A release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "assets_url": { "type": "string", "format": "uri" }, "upload_url": { "type": "string" }, "tarball_url": { "type": "string", "format": "uri", "nullable": true }, "zipball_url": { "type": "string", "format": "uri", "nullable": true }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "tag_name": { "description": "The name of the tag.", "example": "v1.0.0", "type": "string" }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "example": "master", "type": "string" }, "name": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "draft": { "description": "true to create a draft (unpublished) release, false to create a published one.", "example": false, "type": "boolean" }, "prerelease": { "description": "Whether to identify the release as a prerelease or a full release.", "example": false, "type": "boolean" }, "immutable": { "description": "Whether or not the release is immutable.", "example": false, "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "published_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "nullable": true, "format": "date-time" }, "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "example": "Team Environment" }, "label": { "type": "string", "nullable": true }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "digest": { "type": "string", "nullable": true }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true } }, "required": [ "id", "name", "content_type", "size", "digest", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "mentions_count": { "type": "integer" }, "discussion_url": { "description": "The URL of the release discussion.", "type": "string", "format": "uri" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assets_url", "upload_url", "tarball_url", "zipball_url", "created_at", "published_at", "draft", "id", "node_id", "author", "html_url", "name", "prerelease", "tag_name", "target_commitish", "assets", "url" ] }, { "type": "object", "properties": { "is_short_description_html_truncated": { "type": "boolean" }, "short_description_html": { "type": "string" } } } ] } }, "required": [ "action", "release" ] }, { "title": "WatchEvent", "type": "object", "properties": { "action": { "type": "string" } }, "required": [ "action" ] } ] }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } }, "examples": { "default": { "value": [ { "id": "22249084947", "type": "WatchEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "action": "started" }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "repository_id": 1296269, "push_id": 10115855396, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd" }, "public": true, "created_at": "2022-06-07T07:50:26Z" } ] } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "activity", "subcategory": "events" }, "x-octokit": {} } }, "/feeds": { "get": { "summary": "Get feeds", "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\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.", "tags": [ "activity" ], "operationId": "activity/get-feeds", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/feeds#get-feeds" }, "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Feed", "description": "Feed", "type": "object", "properties": { "timeline_url": { "type": "string", "example": "https://github.com/timeline" }, "user_url": { "type": "string", "example": "https://github.com/{user}" }, "current_user_public_url": { "type": "string", "example": "https://github.com/octocat" }, "current_user_url": { "type": "string", "example": "https://github.com/octocat.private?token=abc123" }, "current_user_actor_url": { "type": "string", "example": "https://github.com/octocat.private.actor?token=abc123" }, "current_user_organization_url": { "type": "string", "example": "https://github.com/octocat-org" }, "current_user_organization_urls": { "type": "array", "example": [ "https://github.com/organizations/github/octocat.private.atom?token=abc123" ], "items": { "type": "string", "format": "uri" } }, "security_advisories_url": { "type": "string", "example": "https://github.com/security-advisories" }, "repository_discussions_url": { "type": "string", "example": "https://github.com/{user}/{repo}/discussions", "description": "A feed of discussions for a given repository." }, "repository_discussions_category_url": { "type": "string", "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", "description": "A feed of discussions for a given repository and category." }, "_links": { "type": "object", "properties": { "timeline": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "user": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "security_advisories": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user_public": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user_actor": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user_organization": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "current_user_organizations": { "type": "array", "items": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] } }, "repository_discussions": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] }, "repository_discussions_category": { "title": "Link With Type", "description": "Hypermedia Link with Type", "type": "object", "properties": { "href": { "type": "string" }, "type": { "type": "string" } }, "required": [ "href", "type" ] } }, "required": [ "timeline", "user" ] } }, "required": [ "_links", "timeline_url", "user_url" ] }, "examples": { "default": { "value": { "timeline_url": "https://github.com/timeline", "user_url": "https://github.com/{user}", "current_user_public_url": "https://github.com/octocat", "current_user_url": "https://github.com/octocat.private?token=abc123", "current_user_actor_url": "https://github.com/octocat.private.actor?token=abc123", "current_user_organization_url": "", "current_user_organization_urls": [ "https://github.com/organizations/github/octocat.private.atom?token=abc123" ], "security_advisories_url": "https://github.com/security-advisories", "_links": { "timeline": { "href": "https://github.com/timeline", "type": "application/atom+xml" }, "user": { "href": "https://github.com/{user}", "type": "application/atom+xml" }, "current_user_public": { "href": "https://github.com/octocat", "type": "application/atom+xml" }, "current_user": { "href": "https://github.com/octocat.private?token=abc123", "type": "application/atom+xml" }, "current_user_actor": { "href": "https://github.com/octocat.private.actor?token=abc123", "type": "application/atom+xml" }, "current_user_organization": { "href": "", "type": "" }, "current_user_organizations": [ { "href": "https://github.com/organizations/github/octocat.private.atom?token=abc123", "type": "application/atom+xml" } ], "security_advisories": { "href": "https://github.com/security-advisories", "type": "application/atom+xml" } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "activity", "subcategory": "feeds" }, "x-octokit": {} } }, "/gists": { "get": { "summary": "List gists for the authenticated user", "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", "tags": [ "gists" ], "operationId": "gists/list", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user" }, "parameters": [ { "name": "since", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} }, "post": { "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.", "operationId": "gists/create", "tags": [ "gists" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#create-a-gist" }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "description": { "description": "Description of the gist", "example": "Example Ruby script", "type": "string" }, "files": { "description": "Names and content for the files that make up the gist", "example": { "hello.rb": { "content": "puts \"Hello, World!\"" } }, "type": "object", "additionalProperties": { "type": "object", "properties": { "content": { "description": "Content of the file", "readOnly": false, "type": "string" } }, "required": [ "content" ] } }, "public": { "oneOf": [ { "description": "Flag indicating whether the gist is public", "example": true, "type": "boolean", "default": false }, { "type": "string", "example": "true", "default": "false", "enum": [ "true", "false" ] } ] } }, "required": [ "files" ], "type": "object" }, "examples": { "default": { "summary": "Creating a gist", "value": { "description": "Example of a gist", "public": false, "files": { "README.md": { "content": "Hello World" } } } } } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "user_view_type": { "type": "string" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "blog": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "notification_email": { "type": "string", "format": "email", "nullable": true }, "hireable": { "type": "boolean", "nullable": true }, "bio": { "type": "string", "nullable": true }, "twitter_username": { "type": "string", "nullable": true }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "private_gists": { "type": "integer", "example": 1 }, "total_private_repos": { "type": "integer", "example": 2 }, "owned_private_repos": { "type": "integer", "example": 2 }, "disk_usage": { "type": "integer", "example": 1 }, "collaborators": { "type": "integer", "example": 3 } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "nullable": true, "type": "array", "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "nullable": true, "title": "Gist", "description": "Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "nullable": true, "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "type": "string", "nullable": true }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } }, "examples": { "default": { "value": { "url": "https://api.github.com/gists/2decf6c462d9b4418f2", "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", "id": "2decf6c462d9b4418f2", "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "html_url": "https://gist.github.com/2decf6c462d9b4418f2", "files": { "README.md": { "filename": "README.md", "type": "text/markdown", "language": "Markdown", "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, "content": "Hello world from GitHub", "encoding": "utf-8" } }, "public": true, "created_at": "2022-09-20T12:11:58Z", "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", "id": 104456405, "node_id": "U_kgDOBhHyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "forks": [], "history": [ { "user": { "login": "monalisa", "id": 104456405, "node_id": "U_kgyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "version": "468aac8caed5f0c3b859b8286968", "committed_at": "2022-09-21T10:28:06Z", "change_status": { "total": 2, "additions": 1, "deletions": 1 }, "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" } ], "truncated": false } } } } }, "headers": { "Location": { "example": "https://api.github.com/gists/aa5a315d61ae9438b18d", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} } }, "/gists/public": { "get": { "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.", "tags": [ "gists" ], "operationId": "gists/list-public", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#list-public-gists" }, "parameters": [ { "name": "since", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} } }, "/gists/starred": { "get": { "summary": "List starred gists", "description": "List the authenticated user's starred gists:", "tags": [ "gists" ], "operationId": "gists/list-starred", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#list-starred-gists" }, "parameters": [ { "name": "since", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} } }, "/gists/{gist_id}": { "get": { "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.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#get-a-gist" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "user_view_type": { "type": "string" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "blog": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "notification_email": { "type": "string", "format": "email", "nullable": true }, "hireable": { "type": "boolean", "nullable": true }, "bio": { "type": "string", "nullable": true }, "twitter_username": { "type": "string", "nullable": true }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "private_gists": { "type": "integer", "example": 1 }, "total_private_repos": { "type": "integer", "example": 2 }, "owned_private_repos": { "type": "integer", "example": 2 }, "disk_usage": { "type": "integer", "example": 1 }, "collaborators": { "type": "integer", "example": 3 } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "nullable": true, "type": "array", "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "nullable": true, "title": "Gist", "description": "Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "nullable": true, "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "type": "string", "nullable": true }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } }, "examples": { "default": { "value": { "url": "https://api.github.com/gists/2decf6c462d9b4418f2", "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", "id": "2decf6c462d9b4418f2", "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "html_url": "https://gist.github.com/2decf6c462d9b4418f2", "files": { "README.md": { "filename": "README.md", "type": "text/markdown", "language": "Markdown", "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, "content": "Hello world from GitHub", "encoding": "utf-8" } }, "public": true, "created_at": "2022-09-20T12:11:58Z", "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", "id": 104456405, "node_id": "U_kgDOBhHyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "forks": [], "history": [ { "user": { "login": "monalisa", "id": 104456405, "node_id": "U_kgyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "version": "468aac8caed5f0c3b859b8286968", "committed_at": "2022-09-21T10:28:06Z", "change_status": { "total": 2, "additions": 1, "deletions": 1 }, "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" } ], "truncated": false } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden Gist", "content": { "application/json": { "schema": { "type": "object", "properties": { "block": { "type": "object", "properties": { "reason": { "type": "string" }, "created_at": { "type": "string" }, "html_url": { "type": "string", "nullable": true } } }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} }, "patch": { "summary": "Update a gist", "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", "tags": [ "gists" ], "operationId": "gists/update", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/gists/#update-a-gist" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "description": "The description of the gist.", "example": "Example Ruby script", "type": "string" }, "files": { "description": "The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\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`.", "example": { "hello.rb": { "content": "blah", "filename": "goodbye.rb" } }, "type": "object", "additionalProperties": { "type": "object", "nullable": true, "properties": { "content": { "description": "The new content of the file.", "type": "string" }, "filename": { "description": "The new filename for the file.", "type": "string", "nullable": true } } } } }, "nullable": true }, "examples": { "updateGist": { "summary": "Updating a gist", "value": { "description": "An updated gist description", "files": { "README.md": { "content": "Hello World from GitHub" } } } }, "deleteFile": { "summary": "Deleting a gist file", "value": { "files": { "hello.py": null } } }, "renameFile": { "summary": "Renaming a gist file", "value": { "files": { "hello.py": { "filename": "goodbye.py" } } } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "blog": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "hireable": { "type": "boolean", "nullable": true }, "bio": { "type": "string", "nullable": true }, "twitter_username": { "type": "string", "nullable": true }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "suspended_at": { "type": "string", "format": "date-time", "nullable": true }, "private_gists": { "type": "integer", "example": 1 }, "total_private_repos": { "type": "integer", "example": 2 }, "owned_private_repos": { "type": "integer", "example": 2 }, "disk_usage": { "type": "integer", "example": 1 }, "collaborators": { "type": "integer", "example": 3 } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "nullable": true, "type": "array", "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "nullable": true, "title": "Gist", "description": "Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "nullable": true, "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "user": { "type": "string", "nullable": true }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } }, "examples": { "updateGist": { "value": { "url": "https://api.github.com/gists/2decf6c462d9b4418f2", "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", "id": "2decf6c462d9b4418f2", "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "html_url": "https://gist.github.com/2decf6c462d9b4418f2", "files": { "README.md": { "filename": "README.md", "type": "text/markdown", "language": "Markdown", "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, "content": "Hello world from GitHub" } }, "public": true, "created_at": "2022-09-20T12:11:58Z", "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", "id": 104456405, "node_id": "U_kgDOBhHyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "forks": [], "history": [ { "user": { "login": "monalisa", "id": 104456405, "node_id": "U_kgyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "version": "468aac8caed5f0c3b859b8286968", "committed_at": "2022-09-21T10:28:06Z", "change_status": { "total": 2, "additions": 1, "deletions": 1 }, "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" } ], "truncated": false } }, "deleteFile": { "value": { "url": "https://api.github.com/gists/2decf6c462d9b4418f2", "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", "id": "2decf6c462d9b4418f2", "node_id": "G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy", "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "html_url": "https://gist.github.com/2decf6c462d9b4418f2", "files": null, "public": true, "created_at": "2022-09-20T12:11:58Z", "updated_at": "2022-09-21T10:28:06Z", "description": "A gist description.", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", "id": 104456405, "node_id": "U_kgDOBhHyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "forks": [], "history": [ { "user": { "login": "monalisa", "id": 104456405, "node_id": "U_kgyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "version": "9cc352a89178a6d4", "committed_at": "2022-09-21T10:28:06Z", "change_status": { "total": 1, "additions": 0, "deletions": 1 }, "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" } ], "truncated": false } }, "renameFile": { "value": { "url": "https://api.github.com/gists/2decf6c462d9b4418f2", "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", "id": "2decf6c462d9b4418f2", "node_id": "G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy", "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "html_url": "https://gist.github.com/2decf6c462d9b4418f2", "files": { "goodbye.py": { "filename": "goodbye.py", "type": "application/x-python", "language": "Python", "raw_url": "https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py", "size": 4, "truncated": false, "content": "# Hello world" } }, "public": true, "created_at": "2022-09-20T12:11:58Z", "updated_at": "2022-09-21T10:28:06Z", "description": "A gist description.", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", "id": 104456405, "node_id": "U_kgDOBhHyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "forks": [], "history": [ { "user": { "login": "monalisa", "id": 104456405, "node_id": "U_kgyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "version": "468aac8caed5f0c3b859b8286968", "committed_at": "2022-09-21T10:28:06Z", "change_status": { "total": 0, "additions": 0, "deletions": 0 }, "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" } ], "truncated": false } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": null }, "x-octokit": {} }, "delete": { "summary": "Delete a gist", "description": "", "tags": [ "gists" ], "operationId": "gists/delete", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#delete-a-gist" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} } }, "/gists/{gist_id}/comments": { "get": { "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.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/list-comments", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/comments#list-gist-comments" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Gist Comment", "description": "A comment made to a gist.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDExOkdpc3RDb21tZW50MQ==" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" }, "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "example": "Body of the attachment" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-18T23:23:56Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-04-18T23:23:56Z" }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] } }, "required": [ "url", "id", "node_id", "user", "body", "author_association", "created_at", "updated_at" ] } }, "examples": { "default": { "value": [ { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "comments" }, "x-octokit": {} }, "post": { "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.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/create-comment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/comments#create-a-gist-comment" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "example": "Body of the attachment" } }, "type": "object", "required": [ "body" ] }, "examples": { "default": { "summary": "Creating a comment in a gist", "value": { "body": "This is a comment to a gist" } } } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "Gist Comment", "description": "A comment made to a gist.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDExOkdpc3RDb21tZW50MQ==" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" }, "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "example": "Body of the attachment" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-18T23:23:56Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-04-18T23:23:56Z" }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] } }, "required": [ "url", "id", "node_id", "user", "body", "author_association", "created_at", "updated_at" ] }, "examples": { "default": { "value": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" } } } } }, "headers": { "Location": { "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "comments" }, "x-octokit": {} } }, "/gists/{gist_id}/comments/{comment_id}": { "get": { "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.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get-comment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/comments#get-a-gist-comment" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Gist Comment", "description": "A comment made to a gist.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDExOkdpc3RDb21tZW50MQ==" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" }, "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "example": "Body of the attachment" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-18T23:23:56Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-04-18T23:23:56Z" }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] } }, "required": [ "url", "id", "node_id", "user", "body", "author_association", "created_at", "updated_at" ] }, "examples": { "default": { "value": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden Gist", "content": { "application/json": { "schema": { "type": "object", "properties": { "block": { "type": "object", "properties": { "reason": { "type": "string" }, "created_at": { "type": "string" }, "html_url": { "type": "string", "nullable": true } } }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "comments" }, "x-octokit": {} }, "patch": { "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.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/update-comment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/comments#update-a-gist-comment" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "example": "Body of the attachment" } }, "type": "object", "required": [ "body" ] }, "examples": { "default": { "summary": "Updating a comment in a gist", "value": { "body": "This is an update to a comment in a gist" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Gist Comment", "description": "A comment made to a gist.", "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDExOkdpc3RDb21tZW50MQ==" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" }, "body": { "description": "The comment text.", "type": "string", "maxLength": 65535, "example": "Body of the attachment" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-18T23:23:56Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-04-18T23:23:56Z" }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] } }, "required": [ "url", "id", "node_id", "user", "body", "author_association", "created_at", "updated_at" ] }, "examples": { "default": { "value": { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "comments" }, "x-octokit": {} }, "delete": { "summary": "Delete a gist comment", "description": "", "tags": [ "gists" ], "operationId": "gists/delete-comment", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/comments#delete-a-gist-comment" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "comment_id", "description": "The unique identifier of the comment.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Response" }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "comments" }, "x-octokit": {} } }, "/gists/{gist_id}/commits": { "get": { "summary": "List gist commits", "description": "", "tags": [ "gists" ], "operationId": "gists/list-commits", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#list-gist-commits" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Gist Commit", "description": "Gist Commit", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" }, "version": { "type": "string", "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "committed_at": { "type": "string", "format": "date-time", "example": "2010-04-14T02:15:15Z" } }, "required": [ "url", "user", "version", "committed_at", "change_status" ] } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "change_status": { "deletions": 0, "additions": 180, "total": 180 }, "committed_at": "2010-04-14T02:15:15Z" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} } }, "/gists/{gist_id}/forks": { "get": { "summary": "List gist forks", "description": "", "tags": [ "gists" ], "operationId": "gists/list-forks", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#list-gist-forks" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "user_view_type": { "type": "string" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "blog": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "notification_email": { "type": "string", "format": "email", "nullable": true }, "hireable": { "type": "boolean", "nullable": true }, "bio": { "type": "string", "nullable": true }, "twitter_username": { "type": "string", "nullable": true }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "private_gists": { "type": "integer", "example": 1 }, "total_private_repos": { "type": "integer", "example": 2 }, "owned_private_repos": { "type": "integer", "example": 2 }, "disk_usage": { "type": "integer", "example": 1 }, "collaborators": { "type": "integer", "example": 3 } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "nullable": true, "type": "array", "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "nullable": true, "title": "Gist", "description": "Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "nullable": true, "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "type": "string", "nullable": true }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 1, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} }, "post": { "summary": "Fork a gist", "description": "", "tags": [ "gists" ], "operationId": "gists/fork", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#fork-a-gist" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "Base Gist", "description": "Base Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "examples": { "default": { "value": { "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", "id": "aa5a315d61ae9438b18d", "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", "files": { "hello_world.rb": { "filename": "hello_world.rb", "type": "application/x-ruby", "language": "Ruby", "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", "size": 167 } }, "public": true, "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "truncated": false } } } } }, "headers": { "Location": { "example": "https://api.github.com/gists/aa5a315d61ae9438b18d", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} } }, "/gists/{gist_id}/star": { "get": { "summary": "Check if a gist is starred", "description": "", "tags": [ "gists" ], "operationId": "gists/check-is-starred", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response if gist is starred" }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Not Found if gist is not starred", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} }, "put": { "summary": "Star a gist", "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "gists" ], "operationId": "gists/star", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#star-a-gist" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} }, "delete": { "summary": "Unstar a gist", "description": "", "tags": [ "gists" ], "operationId": "gists/unstar", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#unstar-a-gist" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} } }, "/gists/{gist_id}/{sha}": { "get": { "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.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get-revision", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gists/gists#get-a-gist-revision" }, "parameters": [ { "name": "gist_id", "description": "The unique identifier of the gist.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sha", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Gist Simple", "description": "Gist Simple", "type": "object", "properties": { "forks": { "deprecated": true, "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "Public User", "description": "Public User", "type": "object", "properties": { "login": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "user_view_type": { "type": "string" }, "node_id": { "type": "string" }, "avatar_url": { "type": "string", "format": "uri" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string" }, "gists_url": { "type": "string" }, "starred_url": { "type": "string" }, "subscriptions_url": { "type": "string", "format": "uri" }, "organizations_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string" }, "received_events_url": { "type": "string", "format": "uri" }, "type": { "type": "string" }, "site_admin": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true }, "blog": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "notification_email": { "type": "string", "format": "email", "nullable": true }, "hireable": { "type": "boolean", "nullable": true }, "bio": { "type": "string", "nullable": true }, "twitter_username": { "type": "string", "nullable": true }, "public_repos": { "type": "integer" }, "public_gists": { "type": "integer" }, "followers": { "type": "integer" }, "following": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "plan": { "type": "object", "properties": { "collaborators": { "type": "integer" }, "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" } }, "required": [ "collaborators", "name", "space", "private_repos" ] }, "private_gists": { "type": "integer", "example": 1 }, "total_private_repos": { "type": "integer", "example": 2 }, "owned_private_repos": { "type": "integer", "example": 2 }, "disk_usage": { "type": "integer", "example": 1 }, "collaborators": { "type": "integer", "example": 3 } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url", "bio", "blog", "company", "email", "followers", "following", "hireable", "location", "name", "public_gists", "public_repos", "created_at", "updated_at" ], "additionalProperties": false }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "history": { "deprecated": true, "nullable": true, "type": "array", "items": { "title": "Gist History", "description": "Gist History", "type": "object", "properties": { "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "version": { "type": "string" }, "committed_at": { "type": "string", "format": "date-time" }, "change_status": { "type": "object", "properties": { "total": { "type": "integer" }, "additions": { "type": "integer" }, "deletions": { "type": "integer" } } }, "url": { "type": "string", "format": "uri" } } } }, "fork_of": { "nullable": true, "title": "Gist", "description": "Gist", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "forks_url": { "type": "string", "format": "uri" }, "commits_url": { "type": "string", "format": "uri" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string", "format": "uri" }, "git_push_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "files": { "type": "object", "additionalProperties": { "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "comments_url": { "type": "string", "format": "uri" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "truncated": { "type": "boolean" }, "forks": { "type": "array", "items": {} }, "history": { "type": "array", "items": {} } }, "required": [ "id", "node_id", "url", "forks_url", "commits_url", "git_pull_url", "git_push_url", "html_url", "comments_url", "public", "description", "comments", "user", "files", "created_at", "updated_at" ] }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "commits_url": { "type": "string" }, "id": { "type": "string" }, "node_id": { "type": "string" }, "git_pull_url": { "type": "string" }, "git_push_url": { "type": "string" }, "html_url": { "type": "string" }, "files": { "type": "object", "additionalProperties": { "nullable": true, "type": "object", "properties": { "filename": { "type": "string" }, "type": { "type": "string" }, "language": { "type": "string" }, "raw_url": { "type": "string" }, "size": { "type": "integer" }, "truncated": { "type": "boolean" }, "content": { "type": "string" }, "encoding": { "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } } } }, "public": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "description": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "comments_enabled": { "type": "boolean" }, "user": { "type": "string", "nullable": true }, "comments_url": { "type": "string" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "truncated": { "type": "boolean" } } }, "examples": { "default": { "value": { "url": "https://api.github.com/gists/2decf6c462d9b4418f2", "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", "id": "2decf6c462d9b4418f2", "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", "html_url": "https://gist.github.com/2decf6c462d9b4418f2", "files": { "README.md": { "filename": "README.md", "type": "text/markdown", "language": "Markdown", "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, "content": "Hello world from GitHub", "encoding": "utf-8" } }, "public": true, "created_at": "2022-09-20T12:11:58Z", "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", "id": 104456405, "node_id": "U_kgDOBhHyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "forks": [], "history": [ { "user": { "login": "monalisa", "id": 104456405, "node_id": "U_kgyLQ", "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "html_url": "https://github.com/monalisa", "followers_url": "https://api.github.com/users/monalisa/followers", "following_url": "https://api.github.com/users/monalisa/following{/other_user}", "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", "organizations_url": "https://api.github.com/users/monalisa/orgs", "repos_url": "https://api.github.com/users/monalisa/repos", "events_url": "https://api.github.com/users/monalisa/events{/privacy}", "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", "site_admin": true }, "version": "468aac8caed5f0c3b859b8286968", "committed_at": "2022-09-21T10:28:06Z", "change_status": { "total": 2, "additions": 1, "deletions": 1 }, "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" } ], "truncated": false } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "gists", "subcategory": "gists" }, "x-octokit": {} } }, "/gitignore/templates": { "get": { "summary": "Get all gitignore templates", "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).", "operationId": "gitignore/get-all-templates", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates" }, "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "default": { "value": [ "Actionscript", "Android", "AppceleratorTitanium", "Autotools", "Bancha", "C", "C++" ] } } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "gitignore", "subcategory": "gitignore" }, "x-octokit": {} } }, "/gitignore/templates/{name}": { "get": { "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.", "operationId": "gitignore/get-template", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template" }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Gitignore Template", "description": "Gitignore Template", "type": "object", "properties": { "name": { "type": "string", "example": "C" }, "source": { "type": "string", "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" } }, "required": [ "name", "source" ] }, "examples": { "default": { "value": { "name": "C", "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" } } } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "gitignore", "subcategory": "gitignore" }, "x-octokit": {} } }, "/installation/repositories": { "get": { "summary": "List repositories accessible to the app installation", "description": "List repositories that an app installation can access.", "tags": [ "apps" ], "operationId": "apps/list-repos-accessible-to-installation", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "repository_selection": { "type": "string", "example": "selected" } } }, "examples": { "default": { "value": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "installations" }, "x-octokit": {} } }, "/installation/token": { "delete": { "summary": "Revoke an installation access token", "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\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.", "tags": [ "apps" ], "operationId": "apps/revoke-installation-access-token", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token" }, "parameters": [], "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "apps", "subcategory": "installations" }, "x-octokit": {} } }, "/issues": { "get": { "summary": "List issues assigned to the authenticated user", "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\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`.", "tags": [ "issues" ], "operationId": "issues/list", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" }, "parameters": [ { "name": "filter", "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "assigned", "created", "mentioned", "subscribed", "repos", "all" ], "default": "assigned" } }, { "name": "state", "description": "Indicates the state of the issues to return.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "all" ], "default": "open" } }, { "name": "labels", "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "description": "What to sort results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "comments" ], "default": "created" } }, { "name": "direction", "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "since", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "collab", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "orgs", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "owned", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "pulls", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "example": 42, "type": "integer" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "example": "open", "type": "string" }, "state_reason": { "description": "The reason for the current state", "example": "not_planned", "type": "string", "nullable": true, "enum": [ "completed", "reopened", "not_planned", "duplicate" ] }, "title": { "description": "Title of the issue", "example": "Widget creation fails in Safari on OS X 10.8", "type": "string" }, "body": { "description": "Contents of the issue", "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "example": [ "bug", "registration" ], "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "default": { "type": "boolean" } } } ] } }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "nullable": true }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, "labels_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", "example": 1002604 }, "node_id": { "type": "string", "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { "description": "The number of the milestone.", "type": "integer", "example": 42 }, "state": { "description": "The state of the milestone.", "example": "open", "type": "string", "enum": [ "open", "closed" ], "default": "open" }, "title": { "description": "The title of the milestone.", "example": "v1.0", "type": "string" }, "description": { "type": "string", "example": "Tracking milestone for version 1.0", "nullable": true }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "open_issues": { "type": "integer", "example": 4 }, "closed_issues": { "type": "integer", "example": 8 }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2014-03-03T18:58:10Z" }, "closed_at": { "type": "string", "format": "date-time", "example": "2013-02-12T13:22:01Z", "nullable": true }, "due_on": { "type": "string", "format": "date-time", "example": "2012-10-09T23:39:01Z", "nullable": true } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ], "nullable": true }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": "string", "format": "date-time", "nullable": true }, "diff_url": { "type": "string", "format": "uri", "nullable": true }, "html_url": { "type": "string", "format": "uri", "nullable": true }, "patch_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": "object", "nullable": true, "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": "string", "description": "The description of the issue type.", "nullable": true }, "color": { "type": "string", "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple" ], "nullable": true }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": "string", "format": "uri", "nullable": true }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "IFT_GDKND" }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "example": "text" }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "example": "Sample text" }, { "type": "number", "example": 42.5 }, { "type": "integer", "example": 1 } ], "nullable": true }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, "name": { "description": "The name of the option", "type": "string", "example": "High" }, "color": { "description": "The color of the option", "type": "string", "example": "red" } }, "required": [ "id", "name", "color" ], "nullable": true } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "created_at", "updated_at" ] } }, "examples": { "default": { "value": [ { "id": 1, "node_id": "MDU6SXNzdWUx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "repository_url": "https://api.github.com/repos/octocat/Hello-World", "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", "html_url": "https://github.com/octocat/Hello-World/issues/1347", "number": 1347, "state": "open", "title": "Found a bug", "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "labels": [ { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", "name": "bug", "description": "Something isn't working", "color": "f29513", "default": true } ], "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assignees": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", "id": 1002604, "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", "number": 1, "state": "open", "title": "v1.0", "description": "Tracking milestone for version 1.0", "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "open_issues": 4, "closed_issues": 8, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z", "closed_at": "2013-02-12T13:22:01Z", "due_on": "2012-10-09T23:39:01Z" }, "locked": true, "active_lock_reason": "too heated", "comments": 0, "pull_request": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "html_url": "https://github.com/octocat/Hello-World/pull/1347", "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "author_association": "COLLABORATOR" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "issues", "subcategory": "issues" }, "x-octokit": {} } }, "/licenses": { "get": { "summary": "Get all commonly used licenses", "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get-all-commonly-used", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses" }, "parameters": [ { "name": "featured", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ] } }, "examples": { "default": { "value": [ { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "lgpl-3.0", "name": "GNU Lesser General Public License v3.0", "spdx_id": "LGPL-3.0", "url": "https://api.github.com/licenses/lgpl-3.0", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "mpl-2.0", "name": "Mozilla Public License 2.0", "spdx_id": "MPL-2.0", "url": "https://api.github.com/licenses/mpl-2.0", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "agpl-3.0", "name": "GNU Affero General Public License v3.0", "spdx_id": "AGPL-3.0", "url": "https://api.github.com/licenses/agpl-3.0", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "unlicense", "name": "The Unlicense", "spdx_id": "Unlicense", "url": "https://api.github.com/licenses/unlicense", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "apache-2.0", "name": "Apache License 2.0", "spdx_id": "Apache-2.0", "url": "https://api.github.com/licenses/apache-2.0", "node_id": "MDc6TGljZW5zZW1pdA==" }, { "key": "gpl-3.0", "name": "GNU General Public License v3.0", "spdx_id": "GPL-3.0", "url": "https://api.github.com/licenses/gpl-3.0", "node_id": "MDc6TGljZW5zZW1pdA==" } ] } } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "licenses", "subcategory": "licenses" }, "x-octokit": {} } }, "/licenses/{license}": { "get": { "summary": "Get a license", "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/licenses/licenses#get-a-license" }, "parameters": [ { "name": "license", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "License", "description": "License", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "spdx_id": { "type": "string", "example": "MIT", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/licenses/mit", "nullable": true }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri", "example": "http://choosealicense.com/licenses/mit/" }, "description": { "type": "string", "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." }, "implementation": { "type": "string", "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." }, "permissions": { "type": "array", "example": [ "commercial-use", "modifications", "distribution", "sublicense", "private-use" ], "items": { "type": "string" } }, "conditions": { "type": "array", "example": [ "include-copyright" ], "items": { "type": "string" } }, "limitations": { "type": "array", "example": [ "no-liability" ], "items": { "type": "string" } }, "body": { "type": "string", "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, "featured": { "type": "boolean", "example": true } }, "required": [ "key", "name", "url", "spdx_id", "node_id", "html_url", "description", "implementation", "permissions", "conditions", "limitations", "body", "featured" ] }, "examples": { "default": { "value": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "http://choosealicense.com/licenses/mit/", "description": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.", "implementation": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.", "permissions": [ "commercial-use", "modifications", "distribution", "sublicense", "private-use" ], "conditions": [ "include-copyright" ], "limitations": [ "no-liability" ], "body": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", "featured": true } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "licenses", "subcategory": "licenses" }, "x-octokit": {} } }, "/markdown": { "post": { "summary": "Render a Markdown document", "description": "Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`.", "operationId": "markdown/render", "tags": [ "markdown" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/markdown/markdown#render-a-markdown-document" }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "text": { "description": "The Markdown text to render in HTML.", "type": "string" }, "mode": { "description": "The rendering mode.", "enum": [ "markdown", "gfm" ], "default": "markdown", "example": "markdown", "type": "string" }, "context": { "description": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", "type": "string" } }, "required": [ "text" ], "type": "object" }, "examples": { "default": { "summary": "Rendering markdown", "value": { "text": "Hello **world**" } } } } } }, "responses": { "200": { "description": "Response", "headers": { "Content-Type": { "example": "text/html", "schema": { "type": "string" } }, "Content-Length": { "example": "279", "schema": { "type": "string" } }, "X-CommonMarker-Version": { "example": "0.17.4", "schema": { "type": "string" } } }, "content": { "text/html": { "schema": { "type": "string" }, "examples": { "default": { "summary": "Example response", "value": "

Hello world

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

Hello world

" } } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "markdown", "subcategory": "markdown" }, "x-octokit": {} } }, "/marketplace_listing/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account", "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\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.", "tags": [ "apps" ], "operationId": "apps/get-subscription-plan-for-account", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account" }, "parameters": [ { "name": "account_id", "description": "account_id parameter", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Marketplace Purchase", "description": "Marketplace Purchase", "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "login": { "type": "string" }, "organization_billing_email": { "type": "string" }, "email": { "type": "string", "nullable": true }, "marketplace_pending_change": { "type": "object", "properties": { "is_installed": { "type": "boolean" }, "effective_date": { "type": "string" }, "unit_count": { "type": "integer", "nullable": true }, "id": { "type": "integer" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } }, "nullable": true }, "marketplace_purchase": { "type": "object", "properties": { "billing_cycle": { "type": "string" }, "next_billing_date": { "type": "string", "nullable": true }, "is_installed": { "type": "boolean" }, "unit_count": { "type": "integer", "nullable": true }, "on_free_trial": { "type": "boolean" }, "free_trial_ends_on": { "type": "string", "nullable": true }, "updated_at": { "type": "string" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } }, "required": [ "url", "id", "type", "login", "marketplace_purchase" ] }, "examples": { "default": { "value": { "url": "https://api.github.com/orgs/github", "type": "Organization", "id": 4, "login": "github", "organization_billing_email": "billing@github.com", "email": "billing@github.com", "marketplace_pending_change": { "effective_date": "2017-11-11T00:00:00Z", "unit_count": null, "id": 77, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1111", "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", "id": 1111, "number": 2, "name": "Startup", "description": "A professional-grade CI solution", "monthly_price_in_cents": 699, "yearly_price_in_cents": 7870, "price_model": "FLAT_RATE", "has_free_trial": true, "state": "published", "unit_name": null, "bullets": [ "Up to 10 private repositories", "3 concurrent builds" ] } }, "marketplace_purchase": { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "FLAT_RATE", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Not Found when the account has not purchased the listing", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "marketplace" }, "x-octokit": {} } }, "/marketplace_listing/plans": { "get": { "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.", "tags": [ "apps" ], "operationId": "apps/list-plans", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/marketplace#list-plans" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "FLAT_RATE", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "marketplace" }, "x-octokit": {} } }, "/marketplace_listing/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan", "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\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.", "tags": [ "apps" ], "operationId": "apps/list-accounts-for-plan", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan" }, "parameters": [ { "name": "plan_id", "description": "The unique identifier of the plan.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "sort", "description": "The property to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ], "default": "created" } }, { "name": "direction", "description": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Marketplace Purchase", "description": "Marketplace Purchase", "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "login": { "type": "string" }, "organization_billing_email": { "type": "string" }, "email": { "type": "string", "nullable": true }, "marketplace_pending_change": { "type": "object", "properties": { "is_installed": { "type": "boolean" }, "effective_date": { "type": "string" }, "unit_count": { "type": "integer", "nullable": true }, "id": { "type": "integer" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } }, "nullable": true }, "marketplace_purchase": { "type": "object", "properties": { "billing_cycle": { "type": "string" }, "next_billing_date": { "type": "string", "nullable": true }, "is_installed": { "type": "boolean" }, "unit_count": { "type": "integer", "nullable": true }, "on_free_trial": { "type": "boolean" }, "free_trial_ends_on": { "type": "string", "nullable": true }, "updated_at": { "type": "string" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } }, "required": [ "url", "id", "type", "login", "marketplace_purchase" ] } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/orgs/github", "type": "Organization", "id": 4, "login": "github", "organization_billing_email": "billing@github.com", "marketplace_pending_change": { "effective_date": "2017-11-11T00:00:00Z", "unit_count": null, "id": 77, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1111", "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", "id": 1111, "number": 2, "name": "Startup", "description": "A professional-grade CI solution", "monthly_price_in_cents": 699, "yearly_price_in_cents": 7870, "price_model": "FLAT_RATE", "has_free_trial": true, "state": "published", "unit_name": null, "bullets": [ "Up to 10 private repositories", "3 concurrent builds" ] } }, "marketplace_purchase": { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "FLAT_RATE", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "marketplace" }, "x-octokit": {} } }, "/marketplace_listing/stubbed/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account (stubbed)", "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\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.", "tags": [ "apps" ], "operationId": "apps/get-subscription-plan-for-account-stubbed", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed" }, "parameters": [ { "name": "account_id", "description": "account_id parameter", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Marketplace Purchase", "description": "Marketplace Purchase", "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "login": { "type": "string" }, "organization_billing_email": { "type": "string" }, "email": { "type": "string", "nullable": true }, "marketplace_pending_change": { "type": "object", "properties": { "is_installed": { "type": "boolean" }, "effective_date": { "type": "string" }, "unit_count": { "type": "integer", "nullable": true }, "id": { "type": "integer" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } }, "nullable": true }, "marketplace_purchase": { "type": "object", "properties": { "billing_cycle": { "type": "string" }, "next_billing_date": { "type": "string", "nullable": true }, "is_installed": { "type": "boolean" }, "unit_count": { "type": "integer", "nullable": true }, "on_free_trial": { "type": "boolean" }, "free_trial_ends_on": { "type": "string", "nullable": true }, "updated_at": { "type": "string" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } }, "required": [ "url", "id", "type", "login", "marketplace_purchase" ] }, "examples": { "default": { "value": { "url": "https://api.github.com/orgs/github", "type": "Organization", "id": 4, "login": "github", "organization_billing_email": "billing@github.com", "email": "billing@github.com", "marketplace_pending_change": { "effective_date": "2017-11-11T00:00:00Z", "unit_count": null, "id": 77, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1111", "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", "id": 1111, "number": 2, "name": "Startup", "description": "A professional-grade CI solution", "monthly_price_in_cents": 699, "yearly_price_in_cents": 7870, "price_model": "FLAT_RATE", "has_free_trial": true, "state": "published", "unit_name": null, "bullets": [ "Up to 10 private repositories", "3 concurrent builds" ] } }, "marketplace_purchase": { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "FLAT_RATE", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Not Found when the account has not purchased the listing" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "marketplace" }, "x-octokit": {} } }, "/marketplace_listing/stubbed/plans": { "get": { "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.", "tags": [ "apps" ], "operationId": "apps/list-plans-stubbed", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/marketplace#list-plans-stubbed" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "FLAT_RATE", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "marketplace" }, "x-octokit": {} } }, "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan (stubbed)", "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\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.", "tags": [ "apps" ], "operationId": "apps/list-accounts-for-plan-stubbed", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed" }, "parameters": [ { "name": "plan_id", "description": "The unique identifier of the plan.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "sort", "description": "The property to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ], "default": "created" } }, { "name": "direction", "description": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Marketplace Purchase", "description": "Marketplace Purchase", "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer" }, "login": { "type": "string" }, "organization_billing_email": { "type": "string" }, "email": { "type": "string", "nullable": true }, "marketplace_pending_change": { "type": "object", "properties": { "is_installed": { "type": "boolean" }, "effective_date": { "type": "string" }, "unit_count": { "type": "integer", "nullable": true }, "id": { "type": "integer" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } }, "nullable": true }, "marketplace_purchase": { "type": "object", "properties": { "billing_cycle": { "type": "string" }, "next_billing_date": { "type": "string", "nullable": true }, "is_installed": { "type": "boolean" }, "unit_count": { "type": "integer", "nullable": true }, "on_free_trial": { "type": "boolean" }, "free_trial_ends_on": { "type": "string", "nullable": true }, "updated_at": { "type": "string" }, "plan": { "title": "Marketplace Listing Plan", "description": "Marketplace Listing Plan", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313" }, "accounts_url": { "type": "string", "format": "uri", "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" }, "id": { "type": "integer", "example": 1313 }, "number": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Pro" }, "description": { "type": "string", "example": "A professional-grade CI solution" }, "monthly_price_in_cents": { "type": "integer", "example": 1099 }, "yearly_price_in_cents": { "type": "integer", "example": 11870 }, "price_model": { "type": "string", "enum": [ "FREE", "FLAT_RATE", "PER_UNIT" ], "example": "FLAT_RATE" }, "has_free_trial": { "type": "boolean", "example": true }, "unit_name": { "type": "string", "nullable": true }, "state": { "type": "string", "example": "published" }, "bullets": { "type": "array", "items": { "type": "string" }, "example": [ "Up to 25 private repositories", "11 concurrent builds" ] } }, "required": [ "url", "accounts_url", "id", "number", "name", "description", "has_free_trial", "price_model", "unit_name", "monthly_price_in_cents", "state", "yearly_price_in_cents", "bullets" ] } } } }, "required": [ "url", "id", "type", "login", "marketplace_purchase" ] } }, "examples": { "default": { "value": [ { "url": "https://api.github.com/orgs/github", "type": "Organization", "id": 4, "login": "github", "organization_billing_email": "billing@github.com", "marketplace_pending_change": { "effective_date": "2017-11-11T00:00:00Z", "unit_count": null, "id": 77, "plan": { "url": "https://api.github.com/marketplace_listing/plans/1111", "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", "id": 1111, "number": 2, "name": "Startup", "description": "A professional-grade CI solution", "monthly_price_in_cents": 699, "yearly_price_in_cents": 7870, "price_model": "FLAT_RATE", "has_free_trial": true, "state": "published", "unit_name": null, "bullets": [ "Up to 10 private repositories", "3 concurrent builds" ] } }, "marketplace_purchase": { "billing_cycle": "monthly", "next_billing_date": "2017-11-11T00:00:00Z", "unit_count": null, "on_free_trial": true, "free_trial_ends_on": "2017-11-11T00:00:00Z", "updated_at": "2017-11-02T01:12:12Z", "plan": { "url": "https://api.github.com/marketplace_listing/plans/1313", "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", "id": 1313, "number": 3, "name": "Pro", "description": "A professional-grade CI solution", "monthly_price_in_cents": 1099, "yearly_price_in_cents": 11870, "price_model": "FLAT_RATE", "has_free_trial": true, "unit_name": null, "state": "published", "bullets": [ "Up to 25 private repositories", "11 concurrent builds" ] } } } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "apps", "subcategory": "marketplace" }, "x-octokit": {} } }, "/meta": { "get": { "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.\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.", "tags": [ "meta" ], "operationId": "meta/get", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/meta/meta#get-apiname-meta-information" }, "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Api Overview", "description": "Api Overview", "type": "object", "properties": { "verifiable_password_authentication": { "type": "boolean", "example": true }, "ssh_key_fingerprints": { "type": "object", "properties": { "SHA256_RSA": { "type": "string" }, "SHA256_DSA": { "type": "string" }, "SHA256_ECDSA": { "type": "string" }, "SHA256_ED25519": { "type": "string" } } }, "ssh_keys": { "type": "array", "items": { "type": "string" }, "example": [ "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" ] }, "hooks": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "github_enterprise_importer": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "web": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "api": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "git": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "packages": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "pages": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "importer": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "actions": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "actions_macos": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "codespaces": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "dependabot": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "copilot": { "type": "array", "items": { "type": "string" }, "example": [ "192.0.2.1" ] }, "domains": { "type": "object", "properties": { "website": { "type": "array", "items": { "type": "string", "example": [ "example.com" ] } }, "codespaces": { "type": "array", "items": { "type": "string", "example": [ "example.com" ] } }, "copilot": { "type": "array", "items": { "type": "string", "example": [ "example.com" ] } }, "packages": { "type": "array", "items": { "type": "string", "example": [ "example.com" ] } }, "actions": { "type": "array", "items": { "type": "string", "example": [ "example.com" ] } }, "actions_inbound": { "type": "object", "properties": { "full_domains": { "type": "array", "items": { "type": "string", "example": [ "example.com" ] } }, "wildcard_domains": { "type": "array", "items": { "type": "string", "example": [ "example.com" ] } } } }, "artifact_attestations": { "type": "object", "properties": { "trust_domain": { "type": "string", "example": [ "example" ] }, "services": { "type": "array", "items": { "type": "string", "example": [ "example.com" ] } } } } } } }, "required": [ "verifiable_password_authentication" ] }, "examples": { "default": { "value": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { "SHA256_RSA": 1234567890, "SHA256_DSA": 1234567890, "SHA256_ECDSA": 1234567890, "SHA256_ED25519": 1234567890 }, "ssh_keys": [ "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ", "ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ", "ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ" ], "hooks": [ "192.0.2.1" ], "github_enterprise_importer": [ "192.0.2.1" ], "web": [ "192.0.2.1" ], "api": [ "192.0.2.1" ], "git": [ "192.0.2.1" ], "packages": [ "192.0.2.1" ], "pages": [ "192.0.2.1" ], "importer": [ "192.0.2.1" ], "actions": [ "192.0.2.1" ], "actions_macos": [ "192.0.2.1" ], "dependabot": [ "192.0.2.1" ], "copilot": [ "192.0.2.1" ], "domains": { "website": [ "*.example.com" ], "codespaces": [ "*.example.com" ], "copilot": [ "*.example.com" ], "packages": [ "*.example.com" ] } } } } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "meta", "subcategory": "meta" }, "x-octokit": {} } }, "/networks/{owner}/{repo}/events": { "get": { "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.", "tags": [ "activity" ], "operationId": "activity/list-public-events-for-repo-network", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories" }, "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repo", "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "nullable": true }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "oneOf": [ { "title": "CreateEvent", "type": "object", "properties": { "ref": { "type": "string" }, "ref_type": { "type": "string" }, "full_ref": { "type": "string" }, "master_branch": { "type": "string" }, "description": { "type": "string", "nullable": true }, "pusher_type": { "type": "string" } }, "required": [ "ref", "ref_type", "full_ref", "master_branch", "pusher_type" ] }, { "title": "DeleteEvent", "type": "object", "properties": { "ref": { "type": "string" }, "ref_type": { "type": "string" }, "full_ref": { "type": "string" }, "pusher_type": { "type": "string" } }, "required": [ "ref", "ref_type", "full_ref", "pusher_type" ] }, { "title": "DiscussionEvent", "type": "object", "properties": { "action": { "type": "string" }, "discussion": { "title": "Discussion", "description": "A Discussion in a repository.", "type": "object", "properties": { "active_lock_reason": { "type": "string", "nullable": true }, "answer_chosen_at": { "type": "string", "nullable": true }, "answer_chosen_by": { "title": "User", "type": "object", "nullable": true, "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "Bot", "User", "Organization" ] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": [ "login", "id" ] }, "answer_html_url": { "type": "string", "nullable": true }, "author_association": { "title": "AuthorAssociation", "description": "How the author is associated with the repository.", "type": "string", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "body": { "type": "string" }, "category": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "emoji": { "type": "string" }, "id": { "type": "integer" }, "is_answerable": { "type": "boolean" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "repository_id": { "type": "integer" }, "slug": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "repository_id", "emoji", "name", "description", "created_at", "updated_at", "slug", "is_answerable" ] }, "comments": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "html_url": { "type": "string" }, "id": { "type": "integer" }, "locked": { "type": "boolean" }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "reactions": { "title": "Reactions", "type": "object", "properties": { "+1": { "type": "integer" }, "-1": { "type": "integer" }, "confused": { "type": "integer" }, "eyes": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "laugh": { "type": "integer" }, "rocket": { "type": "integer" }, "total_count": { "type": "integer" }, "url": { "type": "string", "format": "uri" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "repository_url": { "type": "string" }, "state": { "type": "string", "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", "enum": [ "open", "closed", "locked", "converting", "transferring" ] }, "state_reason": { "description": "The reason for the current state", "example": "resolved", "type": "string", "nullable": true, "enum": [ "resolved", "outdated", "duplicate", "reopened" ] }, "timeline_url": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "user": { "title": "User", "type": "object", "nullable": true, "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "Bot", "User", "Organization" ] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": [ "login", "id" ] }, "labels": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } }, "required": [ "repository_url", "category", "answer_html_url", "answer_chosen_at", "answer_chosen_by", "html_url", "id", "node_id", "number", "title", "user", "state", "state_reason", "locked", "comments", "created_at", "updated_at", "active_lock_reason", "body" ] } }, "required": [ "action", "discussion" ] }, { "title": "IssuesEvent", "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "example": 42, "type": "integer" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "example": "open", "type": "string" }, "state_reason": { "description": "The reason for the current state", "example": "not_planned", "type": "string", "nullable": true, "enum": [ "completed", "reopened", "not_planned", "duplicate" ] }, "title": { "description": "Title of the issue", "example": "Widget creation fails in Safari on OS X 10.8", "type": "string" }, "body": { "description": "Contents of the issue", "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "example": [ "bug", "registration" ], "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "default": { "type": "boolean" } } } ] } }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "nullable": true }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, "labels_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", "example": 1002604 }, "node_id": { "type": "string", "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { "description": "The number of the milestone.", "type": "integer", "example": 42 }, "state": { "description": "The state of the milestone.", "example": "open", "type": "string", "enum": [ "open", "closed" ], "default": "open" }, "title": { "description": "The title of the milestone.", "example": "v1.0", "type": "string" }, "description": { "type": "string", "example": "Tracking milestone for version 1.0", "nullable": true }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "open_issues": { "type": "integer", "example": 4 }, "closed_issues": { "type": "integer", "example": 8 }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2014-03-03T18:58:10Z" }, "closed_at": { "type": "string", "format": "date-time", "example": "2013-02-12T13:22:01Z", "nullable": true }, "due_on": { "type": "string", "format": "date-time", "example": "2012-10-09T23:39:01Z", "nullable": true } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ], "nullable": true }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": "string", "format": "date-time", "nullable": true }, "diff_url": { "type": "string", "format": "uri", "nullable": true }, "html_url": { "type": "string", "format": "uri", "nullable": true }, "patch_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": "object", "nullable": true, "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": "string", "description": "The description of the issue type.", "nullable": true }, "color": { "type": "string", "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple" ], "nullable": true }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": "string", "format": "uri", "nullable": true }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "IFT_GDKND" }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "example": "text" }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "example": "Sample text" }, { "type": "number", "example": 42.5 }, { "type": "integer", "example": 1 } ], "nullable": true }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, "name": { "description": "The name of the option", "type": "string", "example": "High" }, "color": { "description": "The color of the option", "type": "string", "example": "red" } }, "required": [ "id", "name", "color" ], "nullable": true } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "created_at", "updated_at" ] }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "label": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] }, "labels": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } }, "required": [ "action", "issue" ] }, { "title": "IssueCommentEvent", "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "example": 42, "type": "integer" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "example": "open", "type": "string" }, "state_reason": { "description": "The reason for the current state", "example": "not_planned", "type": "string", "nullable": true, "enum": [ "completed", "reopened", "not_planned", "duplicate" ] }, "title": { "description": "Title of the issue", "example": "Widget creation fails in Safari on OS X 10.8", "type": "string" }, "body": { "description": "Contents of the issue", "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "example": [ "bug", "registration" ], "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "default": { "type": "boolean" } } } ] } }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "nullable": true }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, "labels_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", "example": 1002604 }, "node_id": { "type": "string", "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { "description": "The number of the milestone.", "type": "integer", "example": 42 }, "state": { "description": "The state of the milestone.", "example": "open", "type": "string", "enum": [ "open", "closed" ], "default": "open" }, "title": { "description": "The title of the milestone.", "example": "v1.0", "type": "string" }, "description": { "type": "string", "example": "Tracking milestone for version 1.0", "nullable": true }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "open_issues": { "type": "integer", "example": 4 }, "closed_issues": { "type": "integer", "example": 8 }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2014-03-03T18:58:10Z" }, "closed_at": { "type": "string", "format": "date-time", "example": "2013-02-12T13:22:01Z", "nullable": true }, "due_on": { "type": "string", "format": "date-time", "example": "2012-10-09T23:39:01Z", "nullable": true } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ], "nullable": true }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": "string", "nullable": true }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": "string", "format": "date-time", "nullable": true }, "diff_url": { "type": "string", "format": "uri", "nullable": true }, "html_url": { "type": "string", "format": "uri", "nullable": true }, "patch_url": { "type": "string", "format": "uri", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "diff_url", "html_url", "patch_url", "url" ] }, "closed_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": "object", "nullable": true, "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": "string", "description": "The description of the issue type.", "nullable": true }, "color": { "type": "string", "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple" ], "nullable": true }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": "string", "format": "uri", "nullable": true }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "IFT_GDKND" }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "example": "text" }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "example": "Sample text" }, { "type": "number", "example": 42.5 }, { "type": "integer", "example": 1 } ], "nullable": true }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": "object", "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "example": 1 }, "name": { "description": "The name of the option", "type": "string", "example": "High" }, "color": { "description": "The color of the option", "type": "string", "example": "red" } }, "required": [ "id", "name", "color" ], "nullable": true } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "created_at", "updated_at" ] }, "comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, "body": { "description": "Contents of the issue comment", "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-04-14T16:00:49Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-04-14T16:00:49Z" }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "title": "author_association", "type": "string", "example": "OWNER", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "nullable": true, "properties": { "id": { "description": "Unique identifier of the GitHub app", "example": 37, "type": "integer" }, "slug": { "description": "The slug name of the GitHub app", "example": "probot-owners", "type": "string" }, "node_id": { "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, "client_id": { "type": "string", "example": "\"Iv1.25b5d1e65ffc4022\"" }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": "string", "nullable": true }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/octo-business" }, "website_url": { "description": "The enterprise's website URL.", "type": "string", "nullable": true, "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "example": 42, "type": "integer" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the enterprise.", "type": "string", "example": "Octo Business" }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "example": "octo-business" }, "created_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:01:12Z" }, "updated_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2019-01-26T19:14:43Z" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] } ] }, "name": { "description": "The name of the GitHub app", "example": "Probot Owners", "type": "string" }, "description": { "type": "string", "example": "The description of the app.", "nullable": true }, "external_url": { "type": "string", "format": "uri", "example": "https://example.com" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/apps/super-ci" }, "created_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2017-07-08T16:18:44-04:00" }, "permissions": { "description": "The set of permissions for the GitHub app", "type": "object", "properties": { "issues": { "type": "string" }, "checks": { "type": "string" }, "metadata": { "type": "string" }, "contents": { "type": "string" }, "deployments": { "type": "string" } }, "additionalProperties": { "type": "string" }, "example": { "issues": "read", "deployments": "write" } }, "events": { "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "example": [ "label", "deployment" ], "type": "array", "items": { "type": "string" } }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "example": 5, "type": "integer" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "user", "url", "created_at", "updated_at" ] } }, "required": [ "action", "issue", "comment" ] }, { "title": "ForkEvent", "type": "object", "properties": { "action": { "type": "string" }, "forkee": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "full_name": { "type": "string" }, "private": { "type": "boolean" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "html_url": { "type": "string" }, "description": { "type": "string", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string" }, "forks_url": { "type": "string" }, "keys_url": { "type": "string" }, "collaborators_url": { "type": "string" }, "teams_url": { "type": "string" }, "hooks_url": { "type": "string" }, "issue_events_url": { "type": "string" }, "events_url": { "type": "string" }, "assignees_url": { "type": "string" }, "branches_url": { "type": "string" }, "tags_url": { "type": "string" }, "blobs_url": { "type": "string" }, "git_tags_url": { "type": "string" }, "git_refs_url": { "type": "string" }, "trees_url": { "type": "string" }, "statuses_url": { "type": "string" }, "languages_url": { "type": "string" }, "stargazers_url": { "type": "string" }, "contributors_url": { "type": "string" }, "subscribers_url": { "type": "string" }, "subscription_url": { "type": "string" }, "commits_url": { "type": "string" }, "git_commits_url": { "type": "string" }, "comments_url": { "type": "string" }, "issue_comment_url": { "type": "string" }, "contents_url": { "type": "string" }, "compare_url": { "type": "string" }, "merges_url": { "type": "string" }, "archive_url": { "type": "string" }, "downloads_url": { "type": "string" }, "issues_url": { "type": "string" }, "pulls_url": { "type": "string" }, "milestones_url": { "type": "string" }, "notifications_url": { "type": "string" }, "labels_url": { "type": "string" }, "releases_url": { "type": "string" }, "deployments_url": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "pushed_at": { "type": "string", "format": "date-time", "nullable": true }, "git_url": { "type": "string" }, "ssh_url": { "type": "string" }, "clone_url": { "type": "string" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "size": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "language": { "type": "string", "nullable": true }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "forks_count": { "type": "integer" }, "mirror_url": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "open_issues_count": { "type": "integer" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "allow_forking": { "type": "boolean" }, "is_template": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "visibility": { "type": "string" }, "forks": { "type": "integer" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "default_branch": { "type": "string" }, "public": { "type": "boolean" } } } }, "required": [ "action", "forkee" ] }, { "title": "GollumEvent", "type": "object", "properties": { "pages": { "type": "array", "items": { "type": "object", "properties": { "page_name": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "action": { "type": "string" }, "sha": { "type": "string" }, "html_url": { "type": "string" } } } } }, "required": [ "pages" ] }, { "title": "MemberEvent", "type": "object", "properties": { "action": { "type": "string" }, "member": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "required": [ "action", "member" ] }, { "title": "PublicEvent", "type": "object" }, { "title": "PushEvent", "type": "object", "properties": { "repository_id": { "type": "integer" }, "push_id": { "type": "integer" }, "ref": { "type": "string" }, "head": { "type": "string" }, "before": { "type": "string" } }, "required": [ "repository_id", "push_id", "ref", "head", "before" ] }, { "title": "PullRequestEvent", "type": "object", "properties": { "action": { "type": "string" }, "number": { "type": "integer" }, "pull_request": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "label": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] }, "labels": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } }, "required": [ "action", "number", "pull_request" ] }, { "title": "PullRequestReviewCommentEvent", "type": "object", "properties": { "action": { "type": "string" }, "pull_request": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] }, "comment": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "pull_request_review_id": { "type": "integer", "nullable": true }, "diff_hunk": { "type": "string" }, "path": { "type": "string" }, "position": { "type": "integer", "nullable": true }, "original_position": { "type": "integer" }, "subject_type": { "type": "string", "nullable": true }, "commit_id": { "type": "string" }, "user": { "title": "User", "type": "object", "nullable": true, "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "Bot", "User", "Organization" ] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "body": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "html_url": { "type": "string", "format": "uri" }, "pull_request_url": { "type": "string", "format": "uri" }, "_links": { "type": "object", "properties": { "html": { "title": "Link", "type": "object", "properties": { "href": { "type": "string", "format": "uri-template" } }, "required": [ "href" ] }, "pull_request": { "title": "Link", "type": "object", "properties": { "href": { "type": "string", "format": "uri-template" } }, "required": [ "href" ] }, "self": { "title": "Link", "type": "object", "properties": { "href": { "type": "string", "format": "uri-template" } }, "required": [ "href" ] } }, "required": [ "self", "html", "pull_request" ] }, "original_commit_id": { "type": "string" }, "reactions": { "title": "Reactions", "type": "object", "properties": { "+1": { "type": "integer" }, "-1": { "type": "integer" }, "confused": { "type": "integer" }, "eyes": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "laugh": { "type": "integer" }, "rocket": { "type": "integer" }, "total_count": { "type": "integer" }, "url": { "type": "string", "format": "uri" } } }, "in_reply_to_id": { "type": "integer" } }, "required": [ "url", "pull_request_review_id", "id", "node_id", "diff_hunk", "path", "position", "original_position", "commit_id", "original_commit_id", "user", "body", "created_at", "updated_at", "html_url", "pull_request_url", "_links", "reactions" ] } }, "required": [ "action", "comment", "pull_request" ] }, { "title": "PullRequestReviewEvent", "type": "object", "properties": { "action": { "type": "string" }, "review": { "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "body": { "type": "string" }, "commit_id": { "type": "string" }, "submitted_at": { "type": "string", "nullable": true }, "state": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "pull_request_url": { "type": "string", "format": "uri" }, "_links": { "type": "object", "properties": { "html": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "pull_request": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "html", "pull_request" ] }, "updated_at": { "type": "string" } } }, "pull_request": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url", "name" ] } }, "required": [ "ref", "sha", "repo" ] } }, "required": [ "id", "number", "url", "head", "base" ] } }, "required": [ "action", "review", "pull_request" ] }, { "title": "CommitCommentEvent", "type": "object", "properties": { "action": { "type": "string" }, "comment": { "type": "object", "properties": { "html_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "body": { "type": "string" }, "path": { "type": "string", "nullable": true }, "position": { "type": "integer", "nullable": true }, "line": { "type": "integer", "nullable": true }, "commit_id": { "type": "string" }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } } } }, "required": [ "action", "comment" ] }, { "title": "ReleaseEvent", "type": "object", "properties": { "action": { "type": "string" }, "release": { "allOf": [ { "title": "Release", "description": "A release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "assets_url": { "type": "string", "format": "uri" }, "upload_url": { "type": "string" }, "tarball_url": { "type": "string", "format": "uri", "nullable": true }, "zipball_url": { "type": "string", "format": "uri", "nullable": true }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "tag_name": { "description": "The name of the tag.", "example": "v1.0.0", "type": "string" }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "example": "master", "type": "string" }, "name": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "draft": { "description": "true to create a draft (unpublished) release, false to create a published one.", "example": false, "type": "boolean" }, "prerelease": { "description": "Whether to identify the release as a prerelease or a full release.", "example": false, "type": "boolean" }, "immutable": { "description": "Whether or not the release is immutable.", "example": false, "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "published_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "nullable": true, "format": "date-time" }, "author": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "browser_download_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "description": "The file name of the asset.", "type": "string", "example": "Team Environment" }, "label": { "type": "string", "nullable": true }, "state": { "description": "State of the release asset.", "type": "string", "enum": [ "uploaded", "open" ] }, "content_type": { "type": "string" }, "size": { "type": "integer" }, "digest": { "type": "string", "nullable": true }, "download_count": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true } }, "required": [ "id", "name", "content_type", "size", "digest", "state", "url", "node_id", "download_count", "label", "uploader", "browser_download_url", "created_at", "updated_at" ] } }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "mentions_count": { "type": "integer" }, "discussion_url": { "description": "The URL of the release discussion.", "type": "string", "format": "uri" }, "reactions": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] } }, "required": [ "assets_url", "upload_url", "tarball_url", "zipball_url", "created_at", "published_at", "draft", "id", "node_id", "author", "html_url", "name", "prerelease", "tag_name", "target_commitish", "assets", "url" ] }, { "type": "object", "properties": { "is_short_description_html_truncated": { "type": "boolean" }, "short_description_html": { "type": "string" } } } ] } }, "required": [ "action", "release" ] }, { "title": "WatchEvent", "type": "object", "properties": { "action": { "type": "string" } }, "required": [ "action" ] } ] }, "public": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "type", "actor", "repo", "payload", "public", "created_at" ] } }, "examples": { "default": { "value": [ { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "repository_id": 1296269, "push_id": 10115855396, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd" }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22237752260", "type": "WatchEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "action": "started" }, "public": true, "created_at": "2022-06-08T23:29:25Z" } ] } } } } }, "301": { "description": "Moved permanently", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "activity", "subcategory": "events" }, "x-octokit": {} } }, "/notifications": { "get": { "summary": "List notifications for the authenticated user", "description": "List all notifications for the current user, sorted by most recently updated.", "tags": [ "activity" ], "operationId": "activity/list-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user" }, "parameters": [ { "name": "all", "description": "If `true`, show notifications marked as read.", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "participating", "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "since", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "before", "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`.", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 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).\"", "in": "query", "schema": { "type": "integer", "default": 50 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Thread", "description": "Thread", "type": "object", "properties": { "id": { "type": "string" }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "subject": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "latest_comment_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "title", "url", "latest_comment_url", "type" ] }, "reason": { "type": "string" }, "unread": { "type": "boolean" }, "updated_at": { "type": "string" }, "last_read_at": { "type": "string", "nullable": true }, "url": { "type": "string" }, "subscription_url": { "type": "string", "example": "https://api.github.com/notifications/threads/2/subscription" } }, "required": [ "id", "unread", "reason", "updated_at", "last_read_at", "subject", "repository", "url", "subscription_url" ] } }, "examples": { "default": { "value": [ { "id": "1", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "subject": { "title": "Greetings", "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", "type": "Issue" }, "reason": "subscribed", "unread": true, "updated_at": "2014-11-07T22:01:45Z", "last_read_at": "2014-11-07T22:01:45Z", "url": "https://api.github.com/notifications/threads/1", "subscription_url": "https://api.github.com/notifications/threads/1/subscription" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "activity", "subcategory": "notifications" }, "x-octokit": {} }, "put": { "summary": "Mark notifications as read", "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub 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`.", "tags": [ "activity" ], "operationId": "activity/mark-notifications-as-read", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/notifications#mark-notifications-as-read" }, "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "last_read_at": { "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", "type": "string", "format": "date-time" }, "read": { "description": "Whether the notification has been read.", "type": "boolean" } } }, "examples": { "default": { "value": { "last_read_at": "2022-06-10T00:00:00Z", "read": true } } } } } }, "responses": { "202": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "examples": { "default": { "value": { "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background." } } } } } }, "205": { "description": "Reset Content" }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "activity", "subcategory": "notifications" }, "x-octokit": {} } }, "/notifications/threads/{thread_id}": { "get": { "summary": "Get a thread", "description": "Gets information about a notification thread.", "tags": [ "activity" ], "operationId": "activity/get-thread", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/notifications#get-a-thread" }, "parameters": [ { "name": "thread_id", "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)).", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Thread", "description": "Thread", "type": "object", "properties": { "id": { "type": "string" }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "subject": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "latest_comment_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "title", "url", "latest_comment_url", "type" ] }, "reason": { "type": "string" }, "unread": { "type": "boolean" }, "updated_at": { "type": "string" }, "last_read_at": { "type": "string", "nullable": true }, "url": { "type": "string" }, "subscription_url": { "type": "string", "example": "https://api.github.com/notifications/threads/2/subscription" } }, "required": [ "id", "unread", "reason", "updated_at", "last_read_at", "subject", "repository", "url", "subscription_url" ] }, "examples": { "default": { "value": { "id": "1", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "subject": { "title": "Greetings", "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", "type": "Issue" }, "reason": "subscribed", "unread": true, "updated_at": "2014-11-07T22:01:45Z", "last_read_at": "2014-11-07T22:01:45Z", "url": "https://api.github.com/notifications/threads/1", "subscription_url": "https://api.github.com/notifications/threads/1/subscription" } } } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "activity", "subcategory": "notifications" }, "x-octokit": {} }, "patch": { "summary": "Mark a thread as read", "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.", "tags": [ "activity" ], "operationId": "activity/mark-thread-as-read", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read" }, "parameters": [ { "name": "thread_id", "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)).", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "205": { "description": "Reset Content" }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "activity", "subcategory": "notifications" }, "x-octokit": {} }, "delete": { "summary": "Mark a thread as done", "description": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.", "tags": [ "activity" ], "operationId": "activity/mark-thread-as-done", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done" }, "parameters": [ { "name": "thread_id", "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)).", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "activity", "subcategory": "notifications" }, "x-octokit": {} } }, "/notifications/threads/{thread_id}/subscription": { "get": { "summary": "Get a thread subscription for the authenticated user", "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/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.", "tags": [ "activity" ], "operationId": "activity/get-thread-subscription-for-authenticated-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" }, "parameters": [ { "name": "thread_id", "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)).", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Thread Subscription", "description": "Thread Subscription", "type": "object", "properties": { "subscribed": { "type": "boolean", "example": true }, "ignored": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2012-10-06T21:34:12Z", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/notifications/threads/1/subscription" }, "thread_url": { "type": "string", "format": "uri", "example": "https://api.github.com/notifications/threads/1" }, "repository_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/1" } }, "required": [ "created_at", "ignored", "reason", "url", "subscribed" ] }, "examples": { "default": { "value": { "subscribed": true, "ignored": false, "reason": null, "created_at": "2012-10-06T21:34:12Z", "url": "https://api.github.com/notifications/threads/1/subscription", "thread_url": "https://api.github.com/notifications/threads/1" } } } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "activity", "subcategory": "notifications" }, "x-octokit": {} }, "put": { "summary": "Set a thread subscription", "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\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.", "tags": [ "activity" ], "operationId": "activity/set-thread-subscription", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/notifications#set-a-thread-subscription" }, "parameters": [ { "name": "thread_id", "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)).", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "ignored": { "description": "Whether to block all notifications from a thread.", "default": false, "type": "boolean" } }, "type": "object" }, "examples": { "default": { "value": { "ignored": false } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Thread Subscription", "description": "Thread Subscription", "type": "object", "properties": { "subscribed": { "type": "boolean", "example": true }, "ignored": { "type": "boolean" }, "reason": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2012-10-06T21:34:12Z", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/notifications/threads/1/subscription" }, "thread_url": { "type": "string", "format": "uri", "example": "https://api.github.com/notifications/threads/1" }, "repository_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/1" } }, "required": [ "created_at", "ignored", "reason", "url", "subscribed" ] }, "examples": { "default": { "value": { "subscribed": true, "ignored": false, "reason": null, "created_at": "2012-10-06T21:34:12Z", "url": "https://api.github.com/notifications/threads/1/subscription", "thread_url": "https://api.github.com/notifications/threads/1" } } } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "activity", "subcategory": "notifications" }, "x-octokit": {} }, "delete": { "summary": "Delete a thread subscription", "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", "tags": [ "activity" ], "operationId": "activity/delete-thread-subscription", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription" }, "parameters": [ { "name": "thread_id", "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)).", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "activity", "subcategory": "notifications" }, "x-octokit": {} } }, "/octocat": { "get": { "summary": "Get Octocat", "description": "Get the octocat as ASCII art", "tags": [ "meta" ], "operationId": "meta/get-octocat", "parameters": [ { "name": "s", "in": "query", "description": "The words to show in Octocat's speech bubble", "schema": { "type": "string" }, "required": false } ], "responses": { "200": { "description": "Response", "content": { "application/octocat-stream": { "schema": { "type": "string" }, "examples": { "default": { "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n" } } } } } }, "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/meta/meta#get-octocat" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "meta", "subcategory": "meta" }, "x-octokit": {} } }, "/organizations": { "get": { "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.", "tags": [ "orgs" ], "operationId": "orgs/list", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/orgs#list-organizations" }, "parameters": [ { "name": "since", "description": "An organization ID. Only return organizations with an ID greater than this ID.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Organization Simple", "description": "A GitHub organization.", "type": "object", "properties": { "login": { "type": "string", "example": "github" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/repos" }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/events" }, "hooks_url": { "type": "string", "example": "https://api.github.com/orgs/github/hooks" }, "issues_url": { "type": "string", "example": "https://api.github.com/orgs/github/issues" }, "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, "public_members_url": { "type": "string", "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" }, "description": { "type": "string", "example": "A great organization", "nullable": true } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ] } }, "examples": { "default": { "value": [ { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\"", "schema": { "type": "string" } } } }, "304": { "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "orgs" }, "x-octokit": {} } }, "/organizations/{org}/actions/cache/retention-limit": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/get-actions-cache-retention-limit-for-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Actions cache retention limit for an organization", "description": "GitHub Actions cache retention policy for an organization.", "type": "object", "properties": { "max_cache_retention_days": { "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", "type": "integer", "example": 14 } } }, "examples": { "default": { "value": { "max_cache_retention_days": 80 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} }, "put": { "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.", "tags": [ "actions" ], "operationId": "actions/set-actions-cache-retention-limit-for-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "Actions cache retention limit for an organization", "description": "GitHub Actions cache retention policy for an organization.", "type": "object", "properties": { "max_cache_retention_days": { "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", "type": "integer", "example": 14 } } }, "examples": { "selected_actions": { "value": { "max_cache_retention_days": 80 } } } } } }, "responses": { "204": { "description": "Response" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} } }, "/organizations/{org}/actions/cache/storage-limit": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/get-actions-cache-storage-limit-for-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Actions cache storage limit for an organization", "description": "GitHub Actions cache storage policy for an organization.", "type": "object", "properties": { "max_cache_size_gb": { "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", "type": "integer", "example": 10 } } }, "examples": { "default": { "value": { "max_cache_size_gb": 150 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} }, "put": { "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.", "tags": [ "actions" ], "operationId": "actions/set-actions-cache-storage-limit-for-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "Actions cache storage limit for an organization", "description": "GitHub Actions cache storage policy for an organization.", "type": "object", "properties": { "max_cache_size_gb": { "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", "type": "integer", "example": 10 } } }, "examples": { "selected_actions": { "value": { "max_cache_size_gb": 150 } } } } } }, "responses": { "204": { "description": "Response" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} } }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\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.", "tags": [ "dependabot" ], "operationId": "dependabot/repository-access-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page number of results to fetch.", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "per_page", "in": "query", "description": "Number of results per page.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { "default_level": { "type": "string", "description": "The default repository access level for Dependabot updates.", "enum": [ "public", "internal" ], "example": "internal", "nullable": true }, "accessible_repositories": { "type": "array", "items": { "title": "Simple Repository", "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", "example": "Hello-World", "description": "The name of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", "nullable": true, "description": "The repository description." }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World", "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/contributors", "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/downloads", "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/events", "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/forks", "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/languages", "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/merges", "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscription", "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/tags", "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/teams", "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks", "description": "The API URL to list the hooks on the repository." } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ], "nullable": true } } }, "additionalProperties": false }, "examples": { "default": { "value": { "default_level": "public", "accessible_repositories": [ { "id": 123456, "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", "name": "example-repo", "full_name": "octocat/example-repo", "owner": { "name": "octocat", "email": "octo@github.com", "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", "gravatar_id": 1, "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat/example-repo", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false, "starred_at": "\"2020-07-09T00:17:55Z\"", "user_view_type": "default" }, "private": false, "html_url": "https://github.com/octocat/example-repo", "description": "This is an example repository.", "fork": false, "url": "https://api.github.com/repos/octocat/example-repo", "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", "events_url": "https://api.github.com/repos/octocat/example-repo/events", "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "repository-access" }, "x-octokit": {} }, "patch": { "summary": "Updates Dependabot's repository access list for an organization", "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\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```", "tags": [ "dependabot" ], "operationId": "dependabot/update-repository-access-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "repository_ids_to_add": { "type": "array", "items": { "type": "integer" }, "description": "List of repository IDs to add." }, "repository_ids_to_remove": { "type": "array", "items": { "type": "integer" }, "description": "List of repository IDs to remove." } }, "example": { "repository_ids_to_add": [ 123, 456 ], "repository_ids_to_remove": [ 789 ] } }, "examples": { "204": { "summary": "Example with a 'succeeded' status." }, "add-example": { "summary": "Add repositories", "value": { "repository_ids_to_add": [ 123, 456 ] } }, "remove-example": { "summary": "Remove repositories", "value": { "repository_ids_to_remove": [ 789 ] } } } } } }, "responses": { "204": { "description": "Response" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "repository-access" }, "x-octokit": {} } }, "/organizations/{org}/dependabot/repository-access/default-level": { "put": { "summary": "Set the default repository access level for Dependabot", "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\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.", "tags": [ "dependabot" ], "operationId": "dependabot/set-repository-access-default-level", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "default_level": { "type": "string", "description": "The default repository access level for Dependabot updates.", "enum": [ "public", "internal" ], "example": "internal" } }, "required": [ "default_level" ] }, "examples": { "204": { "summary": "Example with a 'succeeded' status.", "value": { "default_level": "public" } } } } } }, "responses": { "204": { "description": "Response" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "repository-access" }, "x-octokit": {} } }, "/organizations/{org}/org-properties/values": { "get": { "summary": "Get all custom property values for an organization", "description": "Gets all custom property values that are set for an organization.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `read:org` scope\n- Actors with the organization-level \"read custom properties for an organization\" fine-grained permission or above", "tags": [ "orgs" ], "operationId": "orgs/custom-properties-for-orgs-get-organization-values", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#get-all-custom-property-values-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Custom Property Value", "description": "Custom property name and associated value", "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property" }, "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "The value assigned to the property", "nullable": true } }, "required": [ "property_name", "value" ] } }, "examples": { "default": { "value": [ { "property_name": "environment", "value": "production" }, { "property_name": "service", "value": "web" }, { "property_name": "team", "value": "octocat" } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "custom-properties-for-orgs" }, "x-octokit": {} }, "patch": { "summary": "Create or update custom property values for an organization", "description": "Create new or update existing custom property values for an organization.\nTo remove a custom property value from an organization, set the property value to `null`.\n\nThe organization must belong to an enterprise.\n\nAccess requirements:\n- Organization admins\n- OAuth tokens and personal access tokens (classic) with the `admin:org` scope\n- Actors with the organization-level \"edit custom properties for an organization\" fine-grained permission", "tags": [ "orgs" ], "operationId": "orgs/custom-properties-for-orgs-create-or-update-organization-values", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/custom-properties-for-orgs#create-or-update-custom-property-values-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "type": "array", "description": "A list of custom property names and associated values to apply to the organization.", "items": { "title": "Custom Property Value", "description": "Custom property name and associated value", "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property" }, "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "The value assigned to the property", "nullable": true } }, "required": [ "property_name", "value" ] } } }, "required": [ "properties" ] }, "examples": { "default": { "value": { "properties": [ { "property_name": "environment", "value": "production" }, { "property_name": "service", "value": "web" }, { "property_name": "team", "value": "octocat" } ] } } } } } }, "responses": { "204": { "description": "No Content when custom property values are successfully created or updated" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "custom-properties-for-orgs" }, "x-octokit": {} } }, "/organizations/{org}/settings/billing/budgets": { "get": { "summary": "Get all budgets for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.", "tags": [ "billing" ], "operationId": "billing/get-all-budgets-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response when getting all budgets", "content": { "application/json": { "schema": { "type": "object", "properties": { "budgets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the budget", "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" }, "budget_type": { "type": "string", "description": "The type of pricing for the budget", "example": "SkuPricing", "enum": [ "SkuPricing", "ProductPricing" ] }, "budget_amount": { "type": "integer", "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." }, "prevent_further_usage": { "type": "boolean", "description": "The type of limit enforcement for the budget", "example": true }, "budget_scope": { "type": "string", "description": "The scope of the budget (enterprise, organization, repository, cost center)", "example": "enterprise" }, "budget_entity_name": { "type": "string", "description": "The name of the entity for the budget (enterprise does not require a name).", "example": "octocat/hello-world" }, "budget_product_sku": { "type": "string", "description": "A single product or sku to apply the budget to." }, "budget_alerting": { "type": "object", "properties": { "will_alert": { "type": "boolean", "description": "Whether alerts are enabled for this budget", "example": true }, "alert_recipients": { "type": "array", "items": { "type": "string" }, "description": "Array of user login names who will receive alerts", "example": [ "mona", "lisa" ] } }, "required": [ "will_alert", "alert_recipients" ] } }, "required": [ "id", "budget_type", "budget_product_sku", "budget_scope", "budget_amount", "prevent_further_usage", "budget_alerting" ] }, "description": "Array of budget objects for the enterprise" }, "has_next_page": { "type": "boolean", "description": "Indicates if there are more pages of results available (maps to hasNextPage from billing platform)" } }, "required": [ "budgets" ] }, "examples": { "default": { "value": { "budgets": [ { "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", "budget_type": "ProductPricing", "budget_product_skus": [ "actions" ], "budget_scope": "enterprise", "budget_amount": 1000, "prevent_further_usage": true, "budget_alerting": { "will_alert": true, "alert_recipients": [ "enterprise-admin", "billing-manager" ] } }, { "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "budget_type": "SkuPricing", "budget_product_skus": [ "actions_linux" ], "budget_scope": "organization", "budget_amount": 500, "prevent_further_usage": false, "budget_alerting": { "will_alert": true, "alert_recipients": [ "org-owner" ] } }, { "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "budget_type": "ProductPricing", "budget_product_skus": [ "packages" ], "budget_scope": "cost_center", "budget_amount": 250, "prevent_further_usage": true, "budget_alerting": { "will_alert": false, "alert_recipients": [] } } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" }, "x-octokit": {} } }, "/organizations/{org}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", "tags": [ "billing" ], "operationId": "billing/get-budget-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "budget_id", "description": "The ID corresponding to the budget.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response when updating a budget", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the budget." }, "budget_scope": { "type": "string", "description": "The type of scope for the budget", "example": "enterprise", "enum": [ "enterprise", "organization", "repository", "cost_center" ] }, "budget_entity_name": { "type": "string", "description": "The name of the entity to apply the budget to", "example": "octocat/hello-world" }, "budget_amount": { "type": "integer", "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." }, "prevent_further_usage": { "type": "boolean", "description": "Whether to prevent additional spending once the budget is exceeded", "example": true }, "budget_product_sku": { "type": "string", "description": "A single product or sku to apply the budget to.", "example": "actions_linux" }, "budget_type": { "type": "string", "description": "The type of pricing for the budget", "example": "ProductPricing", "enum": [ "ProductPricing", "SkuPricing" ] }, "budget_alerting": { "type": "object", "properties": { "will_alert": { "type": "boolean", "description": "Whether alerts are enabled for this budget", "example": true }, "alert_recipients": { "type": "array", "items": { "type": "string" }, "description": "Array of user login names who will receive alerts", "example": [ "mona", "lisa" ] } } } }, "required": [ "id", "budget_amount", "prevent_further_usage", "budget_product_sku", "budget_type", "budget_alerting", "budget_scope", "budget_entity_name" ] }, "examples": { "default": { "value": { "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", "budget_type": "ProductPricing", "budget_product_sku": "actions_linux", "budget_scope": "repository", "budget_entity_name": "example-repo-name", "budget_amount": 0, "prevent_further_usage": true, "budget_alerting": { "will_alert": true, "alert_recipients": [ "mona", "lisa" ] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" }, "x-octokit": {} }, "patch": { "summary": "Update a budget for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", "tags": [ "billing" ], "operationId": "billing/update-budget-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "budget_id", "description": "The ID corresponding to the budget.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "budget_amount": { "type": "integer", "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." }, "prevent_further_usage": { "type": "boolean", "description": "Whether to prevent additional spending once the budget is exceeded" }, "budget_alerting": { "type": "object", "properties": { "will_alert": { "type": "boolean", "description": "Whether alerts are enabled for this budget" }, "alert_recipients": { "type": "array", "items": { "type": "string" }, "description": "Array of user login names who will receive alerts" } } }, "budget_scope": { "type": "string", "description": "The scope of the budget", "enum": [ "enterprise", "organization", "repository", "cost_center" ] }, "budget_entity_name": { "type": "string", "description": "The name of the entity to apply the budget to" }, "budget_type": { "type": "string", "description": "The type of pricing for the budget", "enum": [ "ProductPricing", "SkuPricing" ] }, "budget_product_sku": { "type": "string", "description": "A single product or SKU that will be covered in the budget" } } }, "examples": { "update-budget": { "summary": "Update budget example", "value": { "prevent_further_usage": false, "budget_amount": 10, "budget_alerting": { "will_alert": false, "alert_recipients": [] } } } } } } }, "responses": { "200": { "description": "Budget updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Budget successfully updated." }, "budget": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the budget." }, "budget_amount": { "type": "number", "format": "float", "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." }, "prevent_further_usage": { "type": "boolean", "description": "Whether to prevent additional spending once the budget is exceeded" }, "budget_alerting": { "type": "object", "required": [ "will_alert", "alert_recipients" ], "properties": { "will_alert": { "type": "boolean", "description": "Whether alerts are enabled for this budget" }, "alert_recipients": { "type": "array", "items": { "type": "string" }, "description": "Array of user login names who will receive alerts" } } }, "budget_scope": { "type": "string", "description": "The scope of the budget", "enum": [ "enterprise", "organization", "repository", "cost_center" ] }, "budget_entity_name": { "type": "string", "description": "The name of the entity to apply the budget to", "default": "" }, "budget_type": { "type": "string", "description": "The type of pricing for the budget", "enum": [ "ProductPricing", "SkuPricing" ] }, "budget_product_sku": { "type": "string", "description": "A single product or SKU that will be covered in the budget" } } } } }, "examples": { "update-budget": { "value": { "message": "Budget successfully updated.", "budget": { "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", "budget_type": "ProductPricing", "budget_product_sku": "actions_linux", "budget_scope": "repository", "budget_entity_name": "org-name/example-repo-name", "budget_amount": 0, "prevent_further_usage": true, "budget_alerting": { "will_alert": true, "alert_recipients": [ "mona", "lisa" ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Budget not found or feature not enabled", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } }, "examples": { "budget-not-found": { "value": { "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" } }, "feature-not-enabled": { "value": { "message": "Not Found", "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } }, "examples": { "server-error": { "value": { "message": "Unable to update budget.", "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "billing", "subcategory": "budgets" }, "x-octokit": {} }, "delete": { "summary": "Delete a budget for an organization", "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", "tags": [ "billing" ], "operationId": "billing/delete-budget-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "budget_id", "description": "The ID corresponding to the budget.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response when deleting a budget", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "A message indicating the result of the deletion operation" }, "id": { "type": "string", "description": "The ID of the deleted budget" } }, "required": [ "message", "id" ] }, "examples": { "default": { "value": { "message": "Budget successfully deleted.", "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" }, "x-octokit": {} } }, "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], "operationId": "billing/get-github-billing-premium-request-usage-report-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "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.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "month", "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.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "day", "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.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "user", "description": "The user name to query usage for. The name is not case sensitive.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "model", "description": "The model name to query usage for. The name is not case sensitive.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product", "description": "The product name to query usage for. The name is not case sensitive.", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response when getting a billing premium request usage report", "content": { "application/json": { "schema": { "type": "object", "properties": { "timePeriod": { "type": "object", "properties": { "year": { "type": "integer", "description": "The year for the usage report." }, "month": { "type": "integer", "description": "The month for the usage report." }, "day": { "type": "integer", "description": "The day for the usage report." } }, "required": [ "year" ] }, "organization": { "type": "string", "description": "The unique identifier of the organization." }, "user": { "type": "string", "description": "The name of the user for the usage report." }, "product": { "type": "string", "description": "The product for the usage report." }, "model": { "type": "string", "description": "The model for the usage report." }, "usageItems": { "type": "array", "items": { "type": "object", "properties": { "product": { "type": "string", "description": "Product name." }, "sku": { "type": "string", "description": "SKU name." }, "model": { "type": "string", "description": "Model name." }, "unitType": { "type": "string", "description": "Unit type of the usage line item." }, "pricePerUnit": { "type": "number", "description": "Price per unit of the usage line item." }, "grossQuantity": { "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { "type": "number", "description": "Gross amount of the usage line item." }, "discountQuantity": { "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { "type": "number", "description": "Discount amount of the usage line item." }, "netQuantity": { "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { "type": "number", "description": "Net amount of the usage line item." } }, "required": [ "product", "sku", "model", "unitType", "pricePerUnit", "grossQuantity", "grossAmount", "discountQuantity", "discountAmount", "netQuantity", "netAmount" ] } } }, "required": [ "timePeriod", "organization", "usageItems" ] }, "examples": { "default": { "value": { "timePeriod": { "year": 2025 }, "organization": "GitHub", "usageItems": [ { "product": "Copilot", "sku": "Copilot Premium Request", "model": "GPT-5", "unitType": "requests", "pricePerUnit": 0.04, "grossQuantity": 100, "grossAmount": 4, "discountQuantity": 0, "discountAmount": 0, "netQuantity": 100, "netAmount": 4 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "billing", "subcategory": "usage" }, "x-octokit": {} } }, "/organizations/{org}/settings/billing/usage": { "get": { "summary": "Get billing usage report for an organization", "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\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).\"", "tags": [ "billing" ], "operationId": "billing/get-github-billing-usage-report-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "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.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "month", "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.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "day", "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.", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Billing usage report response for an organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "usageItems": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Date of the usage line item." }, "product": { "type": "string", "description": "Product name." }, "sku": { "type": "string", "description": "SKU name." }, "quantity": { "type": "integer", "description": "Quantity of the usage line item." }, "unitType": { "type": "string", "description": "Unit type of the usage line item." }, "pricePerUnit": { "type": "number", "description": "Price per unit of the usage line item." }, "grossAmount": { "type": "number", "description": "Gross amount of the usage line item." }, "discountAmount": { "type": "number", "description": "Discount amount of the usage line item." }, "netAmount": { "type": "number", "description": "Net amount of the usage line item." }, "organizationName": { "type": "string", "description": "Name of the organization." }, "repositoryName": { "type": "string", "description": "Name of the repository." } }, "required": [ "date", "product", "sku", "quantity", "unitType", "pricePerUnit", "grossAmount", "discountAmount", "netAmount", "organizationName" ] } } } }, "examples": { "default": { "value": { "usageItems": [ { "date": "2023-08-01", "product": "Actions", "sku": "Actions Linux", "quantity": 100, "unitType": "minutes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "billing", "subcategory": "usage" }, "x-octokit": {} } }, "/organizations/{org}/settings/billing/usage/summary": { "get": { "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.", "tags": [ "billing" ], "operationId": "billing/get-github-billing-usage-summary-report-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "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.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "month", "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.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "day", "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.", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "repository", "description": "The repository name to query for usage in the format owner/repository.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product", "description": "The product name to query usage for. The name is not case sensitive.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sku", "description": "The SKU to query for usage.", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { "type": "object", "properties": { "timePeriod": { "type": "object", "properties": { "year": { "type": "integer", "description": "The year for the usage report." }, "month": { "type": "integer", "description": "The month for the usage report." }, "day": { "type": "integer", "description": "The day for the usage report." } }, "required": [ "year" ] }, "organization": { "type": "string", "description": "The unique identifier of the organization." }, "repository": { "type": "string", "description": "The name of the repository for the usage report." }, "product": { "type": "string", "description": "The product for the usage report." }, "sku": { "type": "string", "description": "The SKU for the usage report." }, "usageItems": { "type": "array", "items": { "type": "object", "properties": { "product": { "type": "string", "description": "Product name." }, "sku": { "type": "string", "description": "SKU name." }, "unitType": { "type": "string", "description": "Unit type of the usage line item." }, "pricePerUnit": { "type": "number", "description": "Price per unit of the usage line item." }, "grossQuantity": { "type": "number", "description": "Gross quantity of the usage line item." }, "grossAmount": { "type": "number", "description": "Gross amount of the usage line item." }, "discountQuantity": { "type": "number", "description": "Discount quantity of the usage line item." }, "discountAmount": { "type": "number", "description": "Discount amount of the usage line item." }, "netQuantity": { "type": "number", "description": "Net quantity of the usage line item." }, "netAmount": { "type": "number", "description": "Net amount of the usage line item." } }, "required": [ "product", "sku", "unitType", "pricePerUnit", "grossQuantity", "grossAmount", "discountQuantity", "discountAmount", "netQuantity", "netAmount" ] } } }, "required": [ "timePeriod", "organization", "usageItems" ] }, "examples": { "default": { "value": { "timePeriod": { "year": 2025 }, "organization": "GitHub", "usageItems": [ { "product": "Actions", "sku": "actions_linux", "unitType": "minutes", "pricePerUnit": 0.008, "grossQuantity": 1000, "grossAmount": 8, "discountQuantity": 0, "discountAmount": 0, "netQuantity": 1000, "netAmount": 8 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "billing", "subcategory": "usage" }, "x-octokit": {} } }, "/orgs/{org}": { "get": { "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.", "tags": [ "orgs" ], "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Organization Full", "description": "Organization Full", "type": "object", "properties": { "login": { "type": "string", "example": "github" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/repos" }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/events" }, "hooks_url": { "type": "string", "example": "https://api.github.com/orgs/github/hooks" }, "issues_url": { "type": "string", "example": "https://api.github.com/orgs/github/issues" }, "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, "public_members_url": { "type": "string", "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" }, "description": { "type": "string", "example": "A great organization", "nullable": true }, "name": { "type": "string", "example": "github" }, "company": { "type": "string", "example": "GitHub" }, "blog": { "type": "string", "format": "uri", "example": "https://github.com/blog" }, "location": { "type": "string", "example": "San Francisco" }, "email": { "type": "string", "format": "email", "example": "octocat@github.com" }, "twitter_username": { "type": "string", "example": "github", "nullable": true }, "is_verified": { "type": "boolean", "example": true }, "has_organization_projects": { "type": "boolean", "example": true }, "has_repository_projects": { "type": "boolean", "example": true }, "public_repos": { "type": "integer", "example": 2 }, "public_gists": { "type": "integer", "example": 1 }, "followers": { "type": "integer", "example": 20 }, "following": { "type": "integer", "example": 0 }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "type": { "type": "string", "example": "Organization" }, "total_private_repos": { "type": "integer", "example": 100 }, "owned_private_repos": { "type": "integer", "example": 100 }, "private_gists": { "type": "integer", "example": 81, "nullable": true }, "disk_usage": { "type": "integer", "example": 10000, "nullable": true }, "collaborators": { "type": "integer", "example": 8, "nullable": true, "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." }, "billing_email": { "type": "string", "format": "email", "example": "org@example.com", "nullable": true }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": "string", "nullable": true }, "default_repository_branch": { "type": "string", "example": "main", "nullable": true, "description": "The default branch for repositories created in this organization." }, "members_can_create_repositories": { "type": "boolean", "example": true, "nullable": true }, "two_factor_requirement_enabled": { "type": "boolean", "example": true, "nullable": true }, "members_allowed_repository_creation_type": { "type": "string", "example": "all" }, "members_can_create_public_repositories": { "type": "boolean", "example": true }, "members_can_create_private_repositories": { "type": "boolean", "example": true }, "members_can_create_internal_repositories": { "type": "boolean", "example": true }, "members_can_create_pages": { "type": "boolean", "example": true }, "members_can_create_public_pages": { "type": "boolean", "example": true }, "members_can_create_private_pages": { "type": "boolean", "example": true }, "members_can_delete_repositories": { "type": "boolean", "example": true }, "members_can_change_repo_visibility": { "type": "boolean", "example": true }, "members_can_invite_outside_collaborators": { "type": "boolean", "example": true }, "members_can_delete_issues": { "type": "boolean", "example": true }, "display_commenter_full_name_setting_enabled": { "type": "boolean", "example": true }, "readers_can_create_discussions": { "type": "boolean", "example": true }, "members_can_create_teams": { "type": "boolean", "example": true }, "members_can_view_dependency_insights": { "type": "boolean", "example": true }, "members_can_fork_private_repositories": { "type": "boolean", "example": false, "nullable": true }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", "example": false, "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." }, "secret_scanning_push_protection_custom_link": { "type": "string", "example": "https://github.com/test-org/test-repo/blob/main/README.md", "nullable": true, "description": "An optional URL string to display to contributors who are blocked from pushing a secret." }, "created_at": { "type": "string", "format": "date-time", "example": "2008-01-14T04:33:35Z" }, "updated_at": { "type": "string", "format": "date-time" }, "archived_at": { "type": "string", "format": "date-time", "nullable": true }, "deploy_keys_enabled_for_repositories": { "type": "boolean", "example": false, "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at", "archived_at" ] }, "examples": { "default-response": { "value": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "twitter_username": "github", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "type": "Organization", "total_private_repos": 100, "owned_private_repos": 100, "private_gists": 81, "disk_usage": 10000, "collaborators": 8, "billing_email": "mona@github.com", "plan": { "name": "Medium", "space": 400, "private_repos": 20, "filled_seats": 4, "seats": 5 }, "default_repository_permission": "read", "default_repository_branch": "main", "members_can_create_repositories": true, "two_factor_requirement_enabled": true, "members_allowed_repository_creation_type": "all", "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, "members_can_create_internal_repositories": false, "members_can_create_pages": true, "members_can_create_public_pages": true, "members_can_create_private_pages": true, "members_can_delete_repositories": true, "members_can_change_repo_visibility": true, "members_can_invite_outside_collaborators": true, "members_can_delete_issues": false, "display_commenter_full_name_setting_enabled": false, "readers_can_create_discussions": true, "members_can_create_teams": true, "members_can_view_dependency_insights": true, "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, "advanced_security_enabled_for_new_repositories": false, "secret_scanning_enabled_for_new_repositories": false, "secret_scanning_push_protection_enabled_for_new_repositories": false, "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", "secret_scanning_push_protection_custom_link_enabled": false } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "orgs" }, "x-octokit": {} }, "patch": { "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.", "tags": [ "orgs" ], "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "billing_email": { "type": "string", "description": "Billing email address. This address is not publicized." }, "company": { "type": "string", "description": "The company name." }, "email": { "type": "string", "description": "The publicly visible email address." }, "twitter_username": { "type": "string", "description": "The Twitter username of the company." }, "location": { "type": "string", "description": "The location." }, "name": { "type": "string", "description": "The shorthand name of the company." }, "description": { "type": "string", "description": "The description of the company. The maximum size is 160 characters." }, "has_organization_projects": { "type": "boolean", "description": "Whether an organization can use organization projects." }, "has_repository_projects": { "type": "boolean", "description": "Whether repositories that belong to the organization can use repository projects." }, "default_repository_permission": { "type": "string", "description": "Default permission level members have for organization repositories.", "enum": [ "read", "write", "admin", "none" ], "default": "read" }, "members_can_create_repositories": { "type": "boolean", "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", "default": true }, "members_can_create_internal_repositories": { "type": "boolean", "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_private_repositories": { "type": "boolean", "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_public_repositories": { "type": "boolean", "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_allowed_repository_creation_type": { "type": "string", "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", "private", "none" ] }, "members_can_create_pages": { "type": "boolean", "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "default": true }, "members_can_create_public_pages": { "type": "boolean", "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", "default": true }, "members_can_create_private_pages": { "type": "boolean", "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", "default": true }, "members_can_fork_private_repositories": { "type": "boolean", "description": "Whether organization members can fork private organization repositories.", "default": false }, "web_commit_signoff_required": { "type": "boolean", "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", "default": false }, "blog": { "type": "string", "example": "\"http://github.blog\"" }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/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.", "deprecated": true }, "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.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/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.", "deprecated": true }, "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.", "deprecated": true }, "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.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/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.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." }, "secret_scanning_push_protection_custom_link": { "type": "string", "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." }, "deploy_keys_enabled_for_repositories": { "type": "boolean", "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, "examples": { "default": { "value": { "billing_email": "mona@github.com", "company": "GitHub", "email": "mona@github.com", "twitter_username": "github", "location": "San Francisco", "name": "github", "description": "GitHub, the company.", "default_repository_permission": "read", "members_can_create_repositories": true, "members_allowed_repository_creation_type": "all" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Organization Full", "description": "Organization Full", "type": "object", "properties": { "login": { "type": "string", "example": "github" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/repos" }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/events" }, "hooks_url": { "type": "string", "example": "https://api.github.com/orgs/github/hooks" }, "issues_url": { "type": "string", "example": "https://api.github.com/orgs/github/issues" }, "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, "public_members_url": { "type": "string", "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" }, "description": { "type": "string", "example": "A great organization", "nullable": true }, "name": { "type": "string", "example": "github" }, "company": { "type": "string", "example": "GitHub" }, "blog": { "type": "string", "format": "uri", "example": "https://github.com/blog" }, "location": { "type": "string", "example": "San Francisco" }, "email": { "type": "string", "format": "email", "example": "octocat@github.com" }, "twitter_username": { "type": "string", "example": "github", "nullable": true }, "is_verified": { "type": "boolean", "example": true }, "has_organization_projects": { "type": "boolean", "example": true }, "has_repository_projects": { "type": "boolean", "example": true }, "public_repos": { "type": "integer", "example": 2 }, "public_gists": { "type": "integer", "example": 1 }, "followers": { "type": "integer", "example": 20 }, "following": { "type": "integer", "example": 0 }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "type": { "type": "string", "example": "Organization" }, "total_private_repos": { "type": "integer", "example": 100 }, "owned_private_repos": { "type": "integer", "example": 100 }, "private_gists": { "type": "integer", "example": 81, "nullable": true }, "disk_usage": { "type": "integer", "example": 10000, "nullable": true }, "collaborators": { "type": "integer", "example": 8, "nullable": true, "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." }, "billing_email": { "type": "string", "format": "email", "example": "org@example.com", "nullable": true }, "plan": { "type": "object", "properties": { "name": { "type": "string" }, "space": { "type": "integer" }, "private_repos": { "type": "integer" }, "filled_seats": { "type": "integer" }, "seats": { "type": "integer" } }, "required": [ "name", "space", "private_repos" ] }, "default_repository_permission": { "type": "string", "nullable": true }, "default_repository_branch": { "type": "string", "example": "main", "nullable": true, "description": "The default branch for repositories created in this organization." }, "members_can_create_repositories": { "type": "boolean", "example": true, "nullable": true }, "two_factor_requirement_enabled": { "type": "boolean", "example": true, "nullable": true }, "members_allowed_repository_creation_type": { "type": "string", "example": "all" }, "members_can_create_public_repositories": { "type": "boolean", "example": true }, "members_can_create_private_repositories": { "type": "boolean", "example": true }, "members_can_create_internal_repositories": { "type": "boolean", "example": true }, "members_can_create_pages": { "type": "boolean", "example": true }, "members_can_create_public_pages": { "type": "boolean", "example": true }, "members_can_create_private_pages": { "type": "boolean", "example": true }, "members_can_delete_repositories": { "type": "boolean", "example": true }, "members_can_change_repo_visibility": { "type": "boolean", "example": true }, "members_can_invite_outside_collaborators": { "type": "boolean", "example": true }, "members_can_delete_issues": { "type": "boolean", "example": true }, "display_commenter_full_name_setting_enabled": { "type": "boolean", "example": true }, "readers_can_create_discussions": { "type": "boolean", "example": true }, "members_can_create_teams": { "type": "boolean", "example": true }, "members_can_view_dependency_insights": { "type": "boolean", "example": true }, "members_can_fork_private_repositories": { "type": "boolean", "example": false, "nullable": true }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", "example": false, "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." }, "secret_scanning_push_protection_custom_link": { "type": "string", "example": "https://github.com/test-org/test-repo/blob/main/README.md", "nullable": true, "description": "An optional URL string to display to contributors who are blocked from pushing a secret." }, "created_at": { "type": "string", "format": "date-time", "example": "2008-01-14T04:33:35Z" }, "updated_at": { "type": "string", "format": "date-time" }, "archived_at": { "type": "string", "format": "date-time", "nullable": true }, "deploy_keys_enabled_for_repositories": { "type": "boolean", "example": false, "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description", "html_url", "has_organization_projects", "has_repository_projects", "public_repos", "public_gists", "followers", "following", "type", "created_at", "updated_at", "archived_at" ] }, "examples": { "default": { "value": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "twitter_username": "github", "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", "type": "Organization", "total_private_repos": 100, "owned_private_repos": 100, "private_gists": 81, "disk_usage": 10000, "collaborators": 8, "billing_email": "mona@github.com", "plan": { "name": "Medium", "space": 400, "private_repos": 20, "filled_seats": 4, "seats": 5 }, "default_repository_permission": "read", "default_repository_branch": "main", "members_can_create_repositories": true, "two_factor_requirement_enabled": true, "members_allowed_repository_creation_type": "all", "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, "members_can_create_internal_repositories": false, "members_can_create_pages": true, "members_can_create_public_pages": true, "members_can_create_private_pages": true, "members_can_delete_repositories": true, "members_can_change_repo_visibility": true, "members_can_invite_outside_collaborators": true, "members_can_delete_issues": false, "display_commenter_full_name_setting_enabled": false, "readers_can_create_discussions": true, "members_can_create_teams": true, "members_can_view_dependency_insights": true, "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, "advanced_security_enabled_for_new_repositories": false, "secret_scanning_enabled_for_new_repositories": false, "secret_scanning_push_protection_enabled_for_new_repositories": false, "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", "secret_scanning_push_protection_custom_link_enabled": false } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "oneOf": [ { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } }, { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } ] } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "orgs" }, "x-octokit": {} }, "delete": { "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", "operationId": "orgs/delete", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "default": { "value": null } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "orgs" }, "x-octokit": {} } }, "/orgs/{org}/actions/cache/usage": { "get": { "summary": "Get GitHub Actions cache usage for an organization", "description": "Gets the total GitHub Actions cache usage for an organization.\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.", "tags": [ "actions" ], "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_active_caches_count": { "type": "integer", "description": "The count of active caches across all repositories of an enterprise or an organization." }, "total_active_caches_size_in_bytes": { "type": "integer", "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." } }, "required": [ "total_active_caches_count", "total_active_caches_size_in_bytes" ] }, "examples": { "default": { "value": { "total_active_caches_size_in_bytes": 3344284, "total_active_caches_count": 5 } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} } }, "/orgs/{org}/actions/cache/usage-by-repository": { "get": { "summary": "List repositories with GitHub Actions cache usage for an organization", "description": "Lists repositories and their GitHub Actions cache usage for an organization.\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.", "tags": [ "actions" ], "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "repository_cache_usages" ], "properties": { "total_count": { "type": "integer" }, "repository_cache_usages": { "type": "array", "items": { "title": "Actions Cache Usage by repository", "description": "GitHub Actions Cache Usage by repository.", "type": "object", "properties": { "full_name": { "description": "The repository owner and name for the cache usage being shown.", "type": "string", "example": "octo-org/Hello-World" }, "active_caches_size_in_bytes": { "description": "The sum of the size in bytes of all the active cache items in the repository.", "type": "integer", "example": 2322142 }, "active_caches_count": { "description": "The number of active caches in the repository.", "type": "integer", "example": 3 } }, "required": [ "full_name", "active_caches_size_in_bytes", "active_caches_count" ] } } } }, "examples": { "default": { "value": { "total_count": 2, "repository_cache_usages": [ { "full_name": "octo-org/Hello-World", "active_caches_size_in_bytes": 2322142, "active_caches_count": 3 }, { "full_name": "octo-org/server", "active_caches_size_in_bytes": 1022142, "active_caches_count": 2 } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "cache" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/list-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "runners" ], "properties": { "total_count": { "type": "integer" }, "runners": { "type": "array", "items": { "title": "GitHub-hosted hosted runner", "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { "description": "The unique identifier of the hosted runner.", "type": "integer", "example": 5 }, "name": { "description": "The name of the hosted runner.", "type": "string", "example": "my-github-hosted-runner" }, "runner_group_id": { "description": "The unique identifier of the group that the hosted runner belongs to.", "type": "integer", "example": 2 }, "image_details": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "example": "ubuntu-20.04" }, "size_gb": { "description": "Image size in GB.", "type": "integer", "example": 86 }, "display_name": { "description": "Display name for this image.", "type": "string", "example": 20.04 }, "source": { "description": "The image provider.", "type": "string", "enum": [ "github", "partner", "custom" ] }, "version": { "description": "The image version of the hosted runner pool.", "type": "string", "example": "latest" } }, "required": [ "id", "size_gb", "display_name", "source" ], "nullable": true }, "machine_size_details": { "title": "Github-owned VM details.", "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", "example": "8-core" }, "cpu_cores": { "description": "The number of cores.", "type": "integer", "example": 8 }, "memory_gb": { "description": "The available RAM for the machine spec.", "type": "integer", "example": 32 }, "storage_gb": { "description": "The available SSD storage for the machine spec.", "type": "integer", "example": 300 } }, "required": [ "id", "cpu_cores", "memory_gb", "storage_gb" ] }, "status": { "description": "The status of the runner.", "type": "string", "example": "Ready", "enum": [ "Ready", "Provisioning", "Shutdown", "Deleting", "Stuck" ] }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "maximum_runners": { "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", "default": 10, "example": 5 }, "public_ip_enabled": { "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "example": true }, "public_ips": { "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { "title": "Public IP for a GitHub-hosted larger runners.", "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { "enabled": { "description": "Whether public IP is enabled.", "type": "boolean", "example": true }, "prefix": { "description": "The prefix for the public IP.", "type": "string", "example": "20.80.208.150" }, "length": { "description": "The length of the IP prefix.", "type": "integer", "example": 28 } } } }, "last_active_on": { "description": "The time at which the runner was last used, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true }, "image_gen": { "type": "boolean", "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ "id", "name", "image_details", "machine_size_details", "status", "public_ip_enabled", "platform" ] } } } }, "examples": { "default": { "value": { "total_count": 2, "runners": [ { "id": 5, "name": "My hosted ubuntu runner", "runner_group_id": 2, "platform": "linux-x64", "image": { "id": "ubuntu-20.04", "size": 86 }, "machine_size_details": { "id": "4-core", "cpu_cores": 4, "memory_gb": 16, "storage_gb": 150 }, "status": "Ready", "maximum_runners": 10, "public_ip_enabled": true, "public_ips": [ { "enabled": true, "prefix": "20.80.208.150", "length": 31 } ], "last_active_on": "2022-10-09T23:39:01Z" }, { "id": 7, "name": "My hosted Windows runner", "runner_group_id": 2, "platform": "win-x64", "image": { "id": "windows-latest", "size": 256 }, "machine_size_details": { "id": "8-core", "cpu_cores": 8, "memory_gb": 32, "storage_gb": 300 }, "status": "Ready", "maximum_runners": 20, "public_ip_enabled": false, "public_ips": [], "last_active_on": "2023-04-26T15:23:37Z" } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} }, "post": { "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.", "operationId": "actions/create-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", "type": "string" }, "image": { "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", "type": "object", "properties": { "id": { "description": "The unique identifier of the runner image.", "type": "string" }, "source": { "description": "The source of the runner image.", "type": "string", "enum": [ "github", "partner", "custom" ] }, "version": { "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true } } }, "size": { "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", "type": "string" }, "runner_group_id": { "description": "The existing runner group to add this runner to.", "type": "integer" }, "maximum_runners": { "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", "type": "integer" }, "enable_static_ip": { "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" }, "image_gen": { "description": "Whether this runner should be used to generate custom images.", "type": "boolean", "default": false } }, "required": [ "name", "image", "size", "runner_group_id" ] }, "examples": { "default": { "value": { "name": "My Hosted runner", "image": { "id": "ubuntu-latest", "source": "github" }, "runner_group_id": 1, "size": "4-core", "maximum_runners": 50, "enable_static_ip": false } } } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub-hosted hosted runner", "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { "description": "The unique identifier of the hosted runner.", "type": "integer", "example": 5 }, "name": { "description": "The name of the hosted runner.", "type": "string", "example": "my-github-hosted-runner" }, "runner_group_id": { "description": "The unique identifier of the group that the hosted runner belongs to.", "type": "integer", "example": 2 }, "image_details": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "example": "ubuntu-20.04" }, "size_gb": { "description": "Image size in GB.", "type": "integer", "example": 86 }, "display_name": { "description": "Display name for this image.", "type": "string", "example": 20.04 }, "source": { "description": "The image provider.", "type": "string", "enum": [ "github", "partner", "custom" ] }, "version": { "description": "The image version of the hosted runner pool.", "type": "string", "example": "latest" } }, "required": [ "id", "size_gb", "display_name", "source" ], "nullable": true }, "machine_size_details": { "title": "Github-owned VM details.", "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", "example": "8-core" }, "cpu_cores": { "description": "The number of cores.", "type": "integer", "example": 8 }, "memory_gb": { "description": "The available RAM for the machine spec.", "type": "integer", "example": 32 }, "storage_gb": { "description": "The available SSD storage for the machine spec.", "type": "integer", "example": 300 } }, "required": [ "id", "cpu_cores", "memory_gb", "storage_gb" ] }, "status": { "description": "The status of the runner.", "type": "string", "example": "Ready", "enum": [ "Ready", "Provisioning", "Shutdown", "Deleting", "Stuck" ] }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "maximum_runners": { "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", "default": 10, "example": 5 }, "public_ip_enabled": { "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "example": true }, "public_ips": { "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { "title": "Public IP for a GitHub-hosted larger runners.", "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { "enabled": { "description": "Whether public IP is enabled.", "type": "boolean", "example": true }, "prefix": { "description": "The prefix for the public IP.", "type": "string", "example": "20.80.208.150" }, "length": { "description": "The length of the IP prefix.", "type": "integer", "example": 28 } } } }, "last_active_on": { "description": "The time at which the runner was last used, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true }, "image_gen": { "type": "boolean", "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ "id", "name", "image_details", "machine_size_details", "status", "public_ip_enabled", "platform" ] }, "examples": { "default": { "value": { "id": 5, "name": "My hosted ubuntu runner", "runner_group_id": 2, "platform": "linux-x64", "image": { "id": "ubuntu-20.04", "size": 86 }, "machine_size_details": { "id": "4-core", "cpu_cores": 4, "memory_gb": 16, "storage_gb": 150 }, "status": "Ready", "maximum_runners": 10, "public_ip_enabled": true, "public_ips": [ { "enabled": true, "prefix": "20.80.208.150", "length": 31 } ], "last_active_on": "2022-10-09T23:39:01Z" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/images/custom": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/list-custom-images-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "images" ], "properties": { "total_count": { "type": "integer" }, "images": { "type": "array", "items": { "title": "GitHub-hosted runner custom image details", "description": "Provides details of a custom runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "integer", "example": 1 }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "total_versions_size": { "description": "Total size of all the image versions in GB.", "type": "integer", "example": 200 }, "name": { "description": "Display name for this image.", "type": "string", "example": "CustomImage" }, "source": { "description": "The image provider.", "type": "string", "example": "custom" }, "versions_count": { "description": "The number of image versions associated with the image.", "type": "integer", "example": 4 }, "latest_version": { "description": "The latest image version associated with the image.", "type": "string", "example": "1.3.0" }, "state": { "description": "The number of image versions associated with the image.", "type": "string", "example": "Ready" } }, "required": [ "id", "platform", "name", "source", "versions_count", "total_versions_size", "latest_version", "state" ] } } } }, "examples": { "default": { "value": { "total_count": 2, "image_versions": [ { "version": "1.1.0", "size_gb": 75, "state": "Ready", "created_on": "2024-11-09T23:39:01Z" }, { "version": "1.0.0", "size_gb": 75, "state": "Ready", "created_on": "2024-11-08T20:39:01Z" } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { "get": { "summary": "Get a custom image definition for GitHub Actions Hosted Runners", "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-custom-image-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "image_definition_id", "description": "Image definition ID of custom image", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub-hosted runner custom image details", "description": "Provides details of a custom runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "integer", "example": 1 }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "total_versions_size": { "description": "Total size of all the image versions in GB.", "type": "integer", "example": 200 }, "name": { "description": "Display name for this image.", "type": "string", "example": "CustomImage" }, "source": { "description": "The image provider.", "type": "string", "example": "custom" }, "versions_count": { "description": "The number of image versions associated with the image.", "type": "integer", "example": 4 }, "latest_version": { "description": "The latest image version associated with the image.", "type": "string", "example": "1.3.0" }, "state": { "description": "The number of image versions associated with the image.", "type": "string", "example": "Ready" } }, "required": [ "id", "platform", "name", "source", "versions_count", "total_versions_size", "latest_version", "state" ] }, "examples": { "default": { "value": { "id": 1, "platform": "linux-x64", "name": "CustomImage", "source": "custom", "versions_count": 4, "total_versions_size": 200, "latest_version": "1.3.0", "state": "Ready" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "actions" ], "operationId": "actions/delete-custom-image-from-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "image_definition_id", "description": "Image definition ID of custom image", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { "get": { "summary": "List image versions of a custom image for an organization", "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/list-custom-image-versions-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" }, "parameters": [ { "name": "image_definition_id", "description": "Image definition ID of custom image", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "image_versions" ], "properties": { "total_count": { "type": "integer" }, "image_versions": { "type": "array", "items": { "title": "GitHub-hosted runner custom image version details.", "description": "Provides details of a hosted runner custom image version", "type": "object", "properties": { "version": { "description": "The version of image.", "type": "string", "example": "1.0.0" }, "state": { "description": "The state of image version.", "type": "string", "example": "Ready" }, "size_gb": { "description": "Image version size in GB.", "type": "integer", "example": 30 }, "created_on": { "description": "The creation date time of the image version.", "type": "string", "example": "2024-11-09T23:39:01Z" }, "state_details": { "description": "The image version status details.", "type": "string", "example": "None" } }, "required": [ "version", "state", "size_gb", "created_on", "state_details" ] } } } }, "examples": { "default": { "value": { "total_count": 2, "image_versions": [ { "version": "1.1.0", "size_gb": 75, "state": "Ready", "created_on": "2024-11-09T23:39:01Z" }, { "version": "1.0.0", "size_gb": 75, "state": "Ready", "created_on": "2024-11-08T20:39:01Z" } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { "get": { "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-custom-image-version-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "image_definition_id", "description": "Image definition ID of custom image", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "version", "description": "Version of a custom image", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub-hosted runner custom image version details.", "description": "Provides details of a hosted runner custom image version", "type": "object", "properties": { "version": { "description": "The version of image.", "type": "string", "example": "1.0.0" }, "state": { "description": "The state of image version.", "type": "string", "example": "Ready" }, "size_gb": { "description": "Image version size in GB.", "type": "integer", "example": 30 }, "created_on": { "description": "The creation date time of the image version.", "type": "string", "example": "2024-11-09T23:39:01Z" }, "state_details": { "description": "The image version status details.", "type": "string", "example": "None" } }, "required": [ "version", "state", "size_gb", "created_on", "state_details" ] }, "examples": { "default": { "value": { "version": "1.0.0", "size_gb": 75, "state": "Ready", "created_on": "2024-11-08T20:39:01Z" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "actions" ], "operationId": "actions/delete-custom-image-version-from-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "image_definition_id", "description": "Image definition ID of custom image", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "version", "description": "Version of a custom image", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/images/github-owned": { "get": { "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", "operationId": "actions/get-hosted-runners-github-owned-images-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "images" ], "properties": { "total_count": { "type": "integer" }, "images": { "type": "array", "items": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "example": "ubuntu-20.04" }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "size_gb": { "description": "Image size in GB.", "type": "integer", "example": 86 }, "display_name": { "description": "Display name for this image.", "type": "string", "example": 20.04 }, "source": { "description": "The image provider.", "type": "string", "enum": [ "github", "partner", "custom" ] } }, "required": [ "id", "platform", "size_gb", "display_name", "source" ] } } } }, "examples": { "default": { "value": { "id": "ubuntu-20.04", "platform": "linux-x64", "size_gb": 86, "display_name": "20.04", "source": "github" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/images/partner": { "get": { "summary": "Get partner images for GitHub-hosted runners in an organization", "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", "operationId": "actions/get-hosted-runners-partner-images-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "images" ], "properties": { "total_count": { "type": "integer" }, "images": { "type": "array", "items": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "example": "ubuntu-20.04" }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "size_gb": { "description": "Image size in GB.", "type": "integer", "example": 86 }, "display_name": { "description": "Display name for this image.", "type": "string", "example": 20.04 }, "source": { "description": "The image provider.", "type": "string", "enum": [ "github", "partner", "custom" ] } }, "required": [ "id", "platform", "size_gb", "display_name", "source" ] } } } }, "examples": { "default": { "value": { "id": "ubuntu-20.04", "platform": "linux-x64", "size_gb": 86, "display_name": "20.04", "source": "github" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/limits": { "get": { "summary": "Get limits on GitHub-hosted runners for an organization", "description": "Get the GitHub-hosted runners limits for an organization.", "operationId": "actions/get-hosted-runners-limits-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "public_ips": { "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", "type": "object", "properties": { "maximum": { "type": "integer", "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", "example": 50 }, "current_usage": { "type": "integer", "description": "The current number of static public IP addresses in use by Hosted Runners.", "example": 17 } }, "required": [ "maximum", "current_usage" ] } }, "required": [ "public_ips" ] }, "examples": { "default": { "value": { "public_ips": { "current_usage": 17, "maximum": 50 } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/machine-sizes": { "get": { "summary": "Get GitHub-hosted runners machine specs for an organization", "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", "operationId": "actions/get-hosted-runners-machine-specs-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "machine_specs" ], "properties": { "total_count": { "type": "integer" }, "machine_specs": { "type": "array", "items": { "title": "Github-owned VM details.", "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", "example": "8-core" }, "cpu_cores": { "description": "The number of cores.", "type": "integer", "example": 8 }, "memory_gb": { "description": "The available RAM for the machine spec.", "type": "integer", "example": 32 }, "storage_gb": { "description": "The available SSD storage for the machine spec.", "type": "integer", "example": 300 } }, "required": [ "id", "cpu_cores", "memory_gb", "storage_gb" ] } } } }, "examples": { "default": { "value": { "id": "4-core", "cpu_cores": 4, "memory_gb": 16, "storage_gb": 150 } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/platforms": { "get": { "summary": "Get platforms for GitHub-hosted runners in an organization", "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", "operationId": "actions/get-hosted-runners-platforms-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "platforms" ], "properties": { "total_count": { "type": "integer" }, "platforms": { "type": "array", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "total_count": 1, "platforms": [ "linux-x64", "win-x64" ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { "get": { "summary": "Get a GitHub-hosted runner for an organization", "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub-hosted hosted runner", "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { "description": "The unique identifier of the hosted runner.", "type": "integer", "example": 5 }, "name": { "description": "The name of the hosted runner.", "type": "string", "example": "my-github-hosted-runner" }, "runner_group_id": { "description": "The unique identifier of the group that the hosted runner belongs to.", "type": "integer", "example": 2 }, "image_details": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "example": "ubuntu-20.04" }, "size_gb": { "description": "Image size in GB.", "type": "integer", "example": 86 }, "display_name": { "description": "Display name for this image.", "type": "string", "example": 20.04 }, "source": { "description": "The image provider.", "type": "string", "enum": [ "github", "partner", "custom" ] }, "version": { "description": "The image version of the hosted runner pool.", "type": "string", "example": "latest" } }, "required": [ "id", "size_gb", "display_name", "source" ], "nullable": true }, "machine_size_details": { "title": "Github-owned VM details.", "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", "example": "8-core" }, "cpu_cores": { "description": "The number of cores.", "type": "integer", "example": 8 }, "memory_gb": { "description": "The available RAM for the machine spec.", "type": "integer", "example": 32 }, "storage_gb": { "description": "The available SSD storage for the machine spec.", "type": "integer", "example": 300 } }, "required": [ "id", "cpu_cores", "memory_gb", "storage_gb" ] }, "status": { "description": "The status of the runner.", "type": "string", "example": "Ready", "enum": [ "Ready", "Provisioning", "Shutdown", "Deleting", "Stuck" ] }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "maximum_runners": { "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", "default": 10, "example": 5 }, "public_ip_enabled": { "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "example": true }, "public_ips": { "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { "title": "Public IP for a GitHub-hosted larger runners.", "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { "enabled": { "description": "Whether public IP is enabled.", "type": "boolean", "example": true }, "prefix": { "description": "The prefix for the public IP.", "type": "string", "example": "20.80.208.150" }, "length": { "description": "The length of the IP prefix.", "type": "integer", "example": 28 } } } }, "last_active_on": { "description": "The time at which the runner was last used, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true }, "image_gen": { "type": "boolean", "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ "id", "name", "image_details", "machine_size_details", "status", "public_ip_enabled", "platform" ] }, "examples": { "default": { "value": { "id": 5, "name": "My hosted ubuntu runner", "runner_group_id": 2, "platform": "linux-x64", "image": { "id": "ubuntu-20.04", "size": 86 }, "machine_size_details": { "id": "4-core", "cpu_cores": 4, "memory_gb": 16, "storage_gb": 150 }, "status": "Ready", "maximum_runners": 10, "public_ip_enabled": true, "public_ips": [ { "enabled": true, "prefix": "20.80.208.150", "length": 31 } ], "last_active_on": "2022-10-09T23:39:01Z" } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} }, "patch": { "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.", "operationId": "actions/update-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", "type": "string" }, "runner_group_id": { "description": "The existing runner group to add this runner to.", "type": "integer" }, "maximum_runners": { "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", "type": "integer" }, "enable_static_ip": { "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", "type": "boolean" }, "image_version": { "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", "type": "string", "nullable": true } } }, "examples": { "default": { "value": { "name": "My larger runner", "runner_group_id": 1, "maximum_runners": 50, "enable_static_ip": false } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub-hosted hosted runner", "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { "description": "The unique identifier of the hosted runner.", "type": "integer", "example": 5 }, "name": { "description": "The name of the hosted runner.", "type": "string", "example": "my-github-hosted-runner" }, "runner_group_id": { "description": "The unique identifier of the group that the hosted runner belongs to.", "type": "integer", "example": 2 }, "image_details": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "example": "ubuntu-20.04" }, "size_gb": { "description": "Image size in GB.", "type": "integer", "example": 86 }, "display_name": { "description": "Display name for this image.", "type": "string", "example": 20.04 }, "source": { "description": "The image provider.", "type": "string", "enum": [ "github", "partner", "custom" ] }, "version": { "description": "The image version of the hosted runner pool.", "type": "string", "example": "latest" } }, "required": [ "id", "size_gb", "display_name", "source" ], "nullable": true }, "machine_size_details": { "title": "Github-owned VM details.", "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", "example": "8-core" }, "cpu_cores": { "description": "The number of cores.", "type": "integer", "example": 8 }, "memory_gb": { "description": "The available RAM for the machine spec.", "type": "integer", "example": 32 }, "storage_gb": { "description": "The available SSD storage for the machine spec.", "type": "integer", "example": 300 } }, "required": [ "id", "cpu_cores", "memory_gb", "storage_gb" ] }, "status": { "description": "The status of the runner.", "type": "string", "example": "Ready", "enum": [ "Ready", "Provisioning", "Shutdown", "Deleting", "Stuck" ] }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "maximum_runners": { "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", "default": 10, "example": 5 }, "public_ip_enabled": { "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "example": true }, "public_ips": { "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { "title": "Public IP for a GitHub-hosted larger runners.", "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { "enabled": { "description": "Whether public IP is enabled.", "type": "boolean", "example": true }, "prefix": { "description": "The prefix for the public IP.", "type": "string", "example": "20.80.208.150" }, "length": { "description": "The length of the IP prefix.", "type": "integer", "example": 28 } } } }, "last_active_on": { "description": "The time at which the runner was last used, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true }, "image_gen": { "type": "boolean", "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ "id", "name", "image_details", "machine_size_details", "status", "public_ip_enabled", "platform" ] }, "examples": { "default": { "value": { "id": 5, "name": "My hosted ubuntu runner", "runner_group_id": 2, "platform": "linux-x64", "image": { "id": "ubuntu-20.04", "size": 86 }, "machine_size_details": { "id": "4-core", "cpu_cores": 4, "memory_gb": 16, "storage_gb": 150 }, "status": "Ready", "maximum_runners": 10, "public_ip_enabled": true, "public_ips": [ { "enabled": true, "prefix": "20.80.208.150", "length": 31 } ], "last_active_on": "2022-10-09T23:39:01Z" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} }, "delete": { "summary": "Delete a GitHub-hosted runner for an organization", "description": "Deletes a GitHub-hosted runner for an organization.", "operationId": "actions/delete-hosted-runner-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hosted_runner_id", "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "202": { "description": "Response", "content": { "application/json": { "schema": { "title": "GitHub-hosted hosted runner", "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { "description": "The unique identifier of the hosted runner.", "type": "integer", "example": 5 }, "name": { "description": "The name of the hosted runner.", "type": "string", "example": "my-github-hosted-runner" }, "runner_group_id": { "description": "The unique identifier of the group that the hosted runner belongs to.", "type": "integer", "example": 2 }, "image_details": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "example": "ubuntu-20.04" }, "size_gb": { "description": "Image size in GB.", "type": "integer", "example": 86 }, "display_name": { "description": "Display name for this image.", "type": "string", "example": 20.04 }, "source": { "description": "The image provider.", "type": "string", "enum": [ "github", "partner", "custom" ] }, "version": { "description": "The image version of the hosted runner pool.", "type": "string", "example": "latest" } }, "required": [ "id", "size_gb", "display_name", "source" ], "nullable": true }, "machine_size_details": { "title": "Github-owned VM details.", "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", "example": "8-core" }, "cpu_cores": { "description": "The number of cores.", "type": "integer", "example": 8 }, "memory_gb": { "description": "The available RAM for the machine spec.", "type": "integer", "example": 32 }, "storage_gb": { "description": "The available SSD storage for the machine spec.", "type": "integer", "example": 300 } }, "required": [ "id", "cpu_cores", "memory_gb", "storage_gb" ] }, "status": { "description": "The status of the runner.", "type": "string", "example": "Ready", "enum": [ "Ready", "Provisioning", "Shutdown", "Deleting", "Stuck" ] }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "maximum_runners": { "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", "default": 10, "example": 5 }, "public_ip_enabled": { "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "example": true }, "public_ips": { "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { "title": "Public IP for a GitHub-hosted larger runners.", "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { "enabled": { "description": "Whether public IP is enabled.", "type": "boolean", "example": true }, "prefix": { "description": "The prefix for the public IP.", "type": "string", "example": "20.80.208.150" }, "length": { "description": "The length of the IP prefix.", "type": "integer", "example": 28 } } } }, "last_active_on": { "description": "The time at which the runner was last used, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true }, "image_gen": { "type": "boolean", "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ "id", "name", "image_details", "machine_size_details", "status", "public_ip_enabled", "platform" ] }, "examples": { "default": { "value": { "id": 5, "name": "My hosted ubuntu runner", "runner_group_id": 2, "platform": "linux-x64", "image": { "id": "ubuntu-20.04", "size": 86 }, "machine_size_details": { "id": "4-core", "cpu_cores": 4, "memory_gb": 16, "storage_gb": 150 }, "status": "Ready", "maximum_runners": 10, "public_ip_enabled": true, "public_ips": [ { "enabled": true, "prefix": "20.80.208.150", "length": 31 } ], "last_active_on": "2022-10-09T23:39:01Z" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "actions", "subcategory": "hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/oidc/customization/sub": { "get": { "summary": "Get the customization template for an OIDC subject claim for an organization", "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ "oidc" ], "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { "title": "Actions OIDC Subject customization", "description": "Actions OIDC Subject customization", "type": "object", "properties": { "include_claim_keys": { "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", "type": "array", "items": { "type": "string" } } }, "required": [ "include_claim_keys" ] }, "examples": { "default": { "value": { "include_claim_keys": [ "repo", "context" ] } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "oidc" }, "x-octokit": {} }, "put": { "summary": "Set the customization template for an OIDC subject claim for an organization", "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ "oidc" ], "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "Actions OIDC Subject customization", "description": "Actions OIDC Subject customization", "type": "object", "properties": { "include_claim_keys": { "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", "type": "array", "items": { "type": "string" } } }, "required": [ "include_claim_keys" ] }, "examples": { "default": { "value": { "include_claim_keys": [ "repo", "context" ] } } } } } }, "responses": { "201": { "description": "Empty response", "content": { "application/json": { "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false }, "examples": { "default": { "value": null } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "previews": [], "category": "actions", "subcategory": "oidc" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions": { "get": { "summary": "Get GitHub Actions permissions for an organization", "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/get-github-actions-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled_repositories": { "type": "string", "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ "all", "none", "selected" ] }, "selected_repositories_url": { "type": "string", "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." }, "allowed_actions": { "type": "string", "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", "enum": [ "all", "local_only", "selected" ] }, "selected_actions_url": { "type": "string", "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." }, "sha_pinning_required": { "type": "boolean", "description": "Whether actions must be pinned to a full-length commit SHA." } }, "required": [ "enabled_repositories" ] }, "examples": { "default": { "value": { "enabled_repositories": "all", "allowed_actions": "selected", "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions", "sha_pinning_required": true } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "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.", "operationId": "actions/set-github-actions-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled_repositories": { "type": "string", "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", "enum": [ "all", "none", "selected" ] }, "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" ] }, "sha_pinning_required": { "type": "boolean", "description": "Whether actions must be pinned to a full-length commit SHA." } }, "required": [ "enabled_repositories" ] }, "examples": { "default": { "value": { "enabled_repositories": "all", "allowed_actions": "selected", "sha_pinning_required": true } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/artifact-and-log-retention": { "get": { "summary": "Get artifact and log retention settings for an organization", "description": "Gets artifact and log retention settings for an organization.\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.", "operationId": "actions/get-artifact-and-log-retention-settings-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "days": { "type": "integer", "description": "The number of days artifacts and logs are retained" }, "maximum_allowed_days": { "type": "integer", "description": "The maximum number of days that can be configured" } }, "required": [ "days", "maximum_allowed_days" ] }, "examples": { "response": { "summary": "Example response", "value": { "days": 90, "maximum_allowed_days": 365 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "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.", "operationId": "actions/set-artifact-and-log-retention-settings-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "days": { "type": "integer", "description": "The number of days to retain artifacts and logs" } }, "required": [ "days" ] }, "examples": { "application/json": { "value": { "days": 100 } } } } } }, "responses": { "204": { "description": "No content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { "get": { "summary": "Get fork PR contributor approval permissions for an organization", "description": "Gets the fork PR contributor approval policy for an organization.\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.", "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "approval_policy": { "type": "string", "enum": [ "first_time_contributors_new_to_github", "first_time_contributors", "all_external_contributors" ], "description": "The policy that controls when fork PR workflows require approval from a maintainer." } }, "required": [ "approval_policy" ] }, "examples": { "default": { "value": { "approval_policy": "first_time_contributors" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "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.", "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "approval_policy": { "type": "string", "enum": [ "first_time_contributors_new_to_github", "first_time_contributors", "all_external_contributors" ], "description": "The policy that controls when fork PR workflows require approval from a maintainer." } }, "required": [ "approval_policy" ] }, "examples": { "default": { "summary": "Set approval policy to first time contributors", "value": { "approval_policy": "first_time_contributors" } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { "get": { "summary": "Get private repo fork PR workflow settings for an organization", "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_workflows_from_fork_pull_requests", "send_write_tokens_to_workflows", "send_secrets_and_variables", "require_approval_for_fork_pr_workflows" ], "properties": { "run_workflows_from_fork_pull_requests": { "type": "boolean", "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, "send_write_tokens_to_workflows": { "type": "boolean", "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, "send_secrets_and_variables": { "type": "boolean", "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, "require_approval_for_fork_pr_workflows": { "type": "boolean", "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "examples": { "default": { "value": { "run_workflows_from_fork_pull_requests": true, "send_write_tokens_to_workflows": false, "send_secrets_and_variables": false, "require_approval_for_fork_pr_workflows": true } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "summary": "Set private repo fork PR workflow settings for an organization", "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "run_workflows_from_fork_pull_requests" ], "properties": { "run_workflows_from_fork_pull_requests": { "type": "boolean", "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, "send_write_tokens_to_workflows": { "type": "boolean", "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, "send_secrets_and_variables": { "type": "boolean", "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, "require_approval_for_fork_pr_workflows": { "type": "boolean", "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "examples": { "default": { "value": { "run_workflows_from_fork_pull_requests": true, "send_write_tokens_to_workflows": false, "send_secrets_and_variables": false, "require_approval_for_fork_pr_workflows": true } } } } } }, "responses": { "204": { "description": "Empty response for successful settings update" }, "403": { "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/repositories": { "get": { "summary": "List selected repositories enabled for GitHub Actions in an organization", "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "number" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } }, "examples": { "default": { "value": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "summary": "Set selected repositories enabled for GitHub Actions in an organization", "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_repository_ids": { "description": "List of repository IDs to enable for GitHub Actions.", "type": "array", "items": { "type": "integer", "description": "Unique identifier of the repository." } } }, "required": [ "selected_repository_ids" ] }, "examples": { "default": { "value": { "selected_repository_ids": [ 32, 42 ] } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/repositories/{repository_id}": { "put": { "summary": "Enable a selected repository for GitHub Actions in an organization", "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/enable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "delete": { "summary": "Disable a selected repository for GitHub Actions in an organization", "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/disable-selected-repository-github-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/selected-actions": { "get": { "summary": "Get allowed actions and reusable workflows for an organization", "description": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/get-allowed-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "github_owned_allowed": { "type": "boolean", "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, "verified_allowed": { "type": "boolean", "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, "patterns_allowed": { "type": "array", "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "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.", "operationId": "actions/set-allowed-actions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "github_owned_allowed": { "type": "boolean", "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, "verified_allowed": { "type": "boolean", "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, "patterns_allowed": { "type": "array", "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", "items": { "type": "string" } } } }, "examples": { "selected_actions": { "value": { "github_owned_allowed": true, "verified_allowed": false, "patterns_allowed": [ "monalisa/octocat@*", "docker/*" ] } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/self-hosted-runners": { "get": { "summary": "Get self-hosted runners settings for an organization", "description": "Gets the settings for self-hosted runners for an organization.\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.", "operationId": "actions/get-self-hosted-runners-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled_repositories" ], "properties": { "enabled_repositories": { "type": "string", "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", "enum": [ "all", "selected", "none" ] }, "selected_repositories_url": { "type": "string", "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" } } }, "examples": { "response": { "summary": "Example response", "value": { "enabled_repositories": "selected", "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "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.", "operationId": "actions/set-self-hosted-runners-permissions-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled_repositories" ], "properties": { "enabled_repositories": { "type": "string", "description": "The policy that controls whether self-hosted runners can be used in the organization", "enum": [ "all", "selected", "none" ] } } }, "examples": { "application/json": { "value": { "enabled_repositories": "all" } } } } } }, "responses": { "204": { "description": "No content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { "get": { "summary": "List repositories allowed to use self-hosted runners in an organization", "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\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.", "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } } } }, "examples": { "default": { "value": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "summary": "Set repositories allowed to use self-hosted runners in an organization", "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\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.", "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "selected_repository_ids" ], "properties": { "selected_repository_ids": { "type": "array", "items": { "type": "integer" }, "description": "IDs of repositories that can use repository-level self-hosted runners" } } }, "examples": { "application/json": { "value": { "selected_repository_ids": [ 1, 2, 3 ] } } } } } }, "responses": { "204": { "description": "No content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { "put": { "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\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.", "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "delete": { "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\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.", "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\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.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "default_workflow_permissions": { "type": "string", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", "enum": [ "read", "write" ] }, "can_approve_pull_request_reviews": { "type": "boolean", "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." } }, "required": [ "default_workflow_permissions", "can_approve_pull_request_reviews" ] }, "examples": { "default": { "summary": "Give read-only permission, and allow approving PRs.", "value": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} }, "put": { "summary": "Set default workflow permissions for an organization", "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\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.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success response" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "default_workflow_permissions": { "type": "string", "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", "enum": [ "read", "write" ] }, "can_approve_pull_request_reviews": { "type": "boolean", "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." } } }, "examples": { "default": { "summary": "Give read-only permission, and allow approving PRs.", "value": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "permissions" }, "x-octokit": {} } }, "/orgs/{org}/actions/runner-groups": { "get": { "summary": "List self-hosted runner groups for an organization", "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/list-self-hosted-runner-groups-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "visible_to_repository", "description": "Only return runner groups that are allowed to be used by this repository.", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "runner_groups" ], "properties": { "total_count": { "type": "number" }, "runner_groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_repositories_url": { "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", "type": "string" }, "runners_url": { "type": "string" }, "hosted_runners_url": { "type": "string" }, "network_configuration_id": { "description": "The identifier of a hosted compute network configuration.", "type": "string" }, "inherited": { "type": "boolean" }, "inherited_allows_public_repositories": { "type": "boolean" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" } } }, "required": [ "id", "name", "visibility", "default", "runners_url", "inherited", "allows_public_repositories" ] } } } }, "examples": { "default": { "value": { "total_count": 3, "runner_groups": [ { "id": 1, "name": "Default", "visibility": "all", "default": true, "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [], "workflow_restrictions_read_only": false }, { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": true, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": true }, { "id": 3, "name": "expensive-hardware", "visibility": "private", "default": false, "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } ] } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} }, "post": { "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.", "operationId": "actions/create-self-hosted-runner-group-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "Name of the runner group.", "type": "string" }, "visibility": { "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", "type": "string", "enum": [ "selected", "all", "private" ], "default": "all" }, "selected_repository_ids": { "description": "List of repository IDs that can access the runner group.", "type": "array", "items": { "type": "integer", "description": "Unique identifier of the repository." } }, "runners": { "description": "List of runner IDs to add to the runner group.", "type": "array", "items": { "type": "integer", "description": "Unique identifier of the runner." } }, "allows_public_repositories": { "description": "Whether the runner group can be used by `public` repositories.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" } }, "network_configuration_id": { "description": "The identifier of a hosted compute network configuration.", "type": "string" } }, "required": [ "name" ] }, "examples": { "default": { "value": { "name": "Expensive hardware runners", "visibility": "selected", "selected_repository_ids": [ 32, 91 ], "runners": [ 9, 2 ] } } } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_repositories_url": { "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", "type": "string" }, "runners_url": { "type": "string" }, "hosted_runners_url": { "type": "string" }, "network_configuration_id": { "description": "The identifier of a hosted compute network configuration.", "type": "string" }, "inherited": { "type": "boolean" }, "inherited_allows_public_repositories": { "type": "boolean" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" } } }, "required": [ "id", "name", "visibility", "default", "runners_url", "inherited", "allows_public_repositories" ] }, "examples": { "default": { "value": { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} } }, "/orgs/{org}/actions/runner-groups/{runner_group_id}": { "get": { "summary": "Get a self-hosted runner group for an organization", "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/get-self-hosted-runner-group-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_repositories_url": { "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", "type": "string" }, "runners_url": { "type": "string" }, "hosted_runners_url": { "type": "string" }, "network_configuration_id": { "description": "The identifier of a hosted compute network configuration.", "type": "string" }, "inherited": { "type": "boolean" }, "inherited_allows_public_repositories": { "type": "boolean" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" } } }, "required": [ "id", "name", "visibility", "default", "runners_url", "inherited", "allows_public_repositories" ] }, "examples": { "default": { "value": { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} }, "patch": { "summary": "Update a self-hosted runner group for an organization", "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/update-self-hosted-runner-group-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "Name of the runner group.", "type": "string" }, "visibility": { "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", "type": "string", "enum": [ "selected", "all", "private" ] }, "allows_public_repositories": { "description": "Whether the runner group can be used by `public` repositories.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" } }, "network_configuration_id": { "description": "The identifier of a hosted compute network configuration.", "type": "string", "nullable": true } }, "required": [ "name" ] }, "examples": { "default": { "value": { "name": "Expensive hardware runners", "visibility": "selected" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "visibility": { "type": "string" }, "default": { "type": "boolean" }, "selected_repositories_url": { "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", "type": "string" }, "runners_url": { "type": "string" }, "hosted_runners_url": { "type": "string" }, "network_configuration_id": { "description": "The identifier of a hosted compute network configuration.", "type": "string" }, "inherited": { "type": "boolean" }, "inherited_allows_public_repositories": { "type": "boolean" }, "allows_public_repositories": { "type": "boolean" }, "workflow_restrictions_read_only": { "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", "type": "boolean", "default": false }, "restricted_to_workflows": { "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", "type": "boolean", "default": false }, "selected_workflows": { "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", "type": "array", "items": { "type": "string", "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" } } }, "required": [ "id", "name", "visibility", "default", "runners_url", "inherited", "allows_public_repositories" ] }, "examples": { "default": { "value": { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} }, "delete": { "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.", "operationId": "actions/delete-self-hosted-runner-group-from-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} } }, "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { "get": { "summary": "List GitHub-hosted runners in a group for an organization", "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/list-github-hosted-runners-in-group-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "runners" ], "properties": { "total_count": { "type": "number" }, "runners": { "type": "array", "items": { "title": "GitHub-hosted hosted runner", "description": "A Github-hosted hosted runner.", "type": "object", "properties": { "id": { "description": "The unique identifier of the hosted runner.", "type": "integer", "example": 5 }, "name": { "description": "The name of the hosted runner.", "type": "string", "example": "my-github-hosted-runner" }, "runner_group_id": { "description": "The unique identifier of the group that the hosted runner belongs to.", "type": "integer", "example": 2 }, "image_details": { "title": "GitHub-hosted runner image details.", "description": "Provides details of a hosted runner image", "type": "object", "properties": { "id": { "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", "type": "string", "example": "ubuntu-20.04" }, "size_gb": { "description": "Image size in GB.", "type": "integer", "example": 86 }, "display_name": { "description": "Display name for this image.", "type": "string", "example": 20.04 }, "source": { "description": "The image provider.", "type": "string", "enum": [ "github", "partner", "custom" ] }, "version": { "description": "The image version of the hosted runner pool.", "type": "string", "example": "latest" } }, "required": [ "id", "size_gb", "display_name", "source" ], "nullable": true }, "machine_size_details": { "title": "Github-owned VM details.", "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { "description": "The ID used for the `size` parameter when creating a new runner.", "type": "string", "example": "8-core" }, "cpu_cores": { "description": "The number of cores.", "type": "integer", "example": 8 }, "memory_gb": { "description": "The available RAM for the machine spec.", "type": "integer", "example": 32 }, "storage_gb": { "description": "The available SSD storage for the machine spec.", "type": "integer", "example": 300 } }, "required": [ "id", "cpu_cores", "memory_gb", "storage_gb" ] }, "status": { "description": "The status of the runner.", "type": "string", "example": "Ready", "enum": [ "Ready", "Provisioning", "Shutdown", "Deleting", "Stuck" ] }, "platform": { "description": "The operating system of the image.", "type": "string", "example": "linux-x64" }, "maximum_runners": { "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", "type": "integer", "default": 10, "example": 5 }, "public_ip_enabled": { "description": "Whether public IP is enabled for the hosted runners.", "type": "boolean", "example": true }, "public_ips": { "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { "title": "Public IP for a GitHub-hosted larger runners.", "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { "enabled": { "description": "Whether public IP is enabled.", "type": "boolean", "example": true }, "prefix": { "description": "The prefix for the public IP.", "type": "string", "example": "20.80.208.150" }, "length": { "description": "The length of the IP prefix.", "type": "integer", "example": 28 } } } }, "last_active_on": { "description": "The time at which the runner was last used, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2022-10-09T23:39:01Z", "nullable": true }, "image_gen": { "type": "boolean", "description": "Whether custom image generation is enabled for the hosted runners." } }, "required": [ "id", "name", "image_details", "machine_size_details", "status", "public_ip_enabled", "platform" ] } } } }, "examples": { "default": { "value": { "total_count": 2, "runners": [ { "id": 5, "name": "My hosted ubuntu runner", "runner_group_id": 2, "platform": "linux-x64", "image": { "id": "ubuntu-20.04", "size": 86 }, "machine_size_details": { "id": "4-core", "cpu_cores": 4, "memory_gb": 16, "storage_gb": 150 }, "status": "Ready", "maximum_runners": 10, "public_ip_enabled": true, "public_ips": [ { "enabled": true, "prefix": "20.80.208.150", "length": 31 } ], "last_active_on": "2022-10-09T23:39:01Z" }, { "id": 7, "name": "My hosted Windows runner", "runner_group_id": 2, "platform": "win-x64", "image": { "id": "windows-latest", "size": 256 }, "machine_size_details": { "id": "8-core", "cpu_cores": 8, "memory_gb": 32, "storage_gb": 300 }, "status": "Ready", "maximum_runners": 20, "public_ip_enabled": false, "public_ips": [], "last_active_on": "2023-04-26T15:23:37Z" } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} } }, "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { "get": { "summary": "List repository access to a self-hosted runner group in an organization", "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "number" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } }, "examples": { "default": { "value": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "organization": null, "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] } } } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} }, "put": { "summary": "Set repository access for a self-hosted runner group in an organization", "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_repository_ids": { "description": "List of repository IDs that can access the runner group.", "type": "array", "items": { "type": "integer", "description": "Unique identifier of the repository." } } }, "required": [ "selected_repository_ids" ] }, "examples": { "default": { "value": { "selected_repository_ids": [ 32, 91 ] } } } } } }, "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} } }, "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { "put": { "summary": "Add repository access to a self-hosted runner group in an organization", "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "repository_id", "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} }, "delete": { "summary": "Remove repository access to a self-hosted runner group in an organization", "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "repository_id", "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} } }, "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { "get": { "summary": "List self-hosted runners in a group for an organization", "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/list-self-hosted-runners-in-group-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "runners" ], "properties": { "total_count": { "type": "number" }, "runners": { "type": "array", "items": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { "description": "The ID of the runner group.", "type": "integer", "example": 1 }, "name": { "description": "The name of the runner.", "type": "string", "example": "iMac" }, "os": { "description": "The Operating System of the runner.", "type": "string", "example": "macos" }, "status": { "description": "The status of the runner.", "type": "string", "example": "online" }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } }, "ephemeral": { "type": "boolean" } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } }, "examples": { "default": { "value": { "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "ephemeral": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "ephemeral": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} }, "put": { "summary": "Set self-hosted runners in a group for an organization", "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/set-self-hosted-runners-in-group-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "runners": { "description": "List of runner IDs to add to the runner group.", "type": "array", "items": { "type": "integer", "description": "Unique identifier of the runner." } } }, "required": [ "runners" ] }, "examples": { "default": { "value": { "runners": [ 9, 2 ] } } } } } }, "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} } }, "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { "put": { "summary": "Add a self-hosted runner to a group for an organization", "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/add-self-hosted-runner-to-group-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} }, "delete": { "summary": "Remove a self-hosted runner from a group for an organization", "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "operationId": "actions/remove-self-hosted-runner-from-group-for-org", "tags": [ "actions" ], "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_group_id", "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, "x-octokit": {} } }, "/orgs/{org}/actions/runners": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ { "name": "name", "description": "The name of a self-hosted runner.", "in": "query", "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "runners" ], "properties": { "total_count": { "type": "integer" }, "runners": { "type": "array", "items": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { "description": "The ID of the runner group.", "type": "integer", "example": 1 }, "name": { "description": "The name of the runner.", "type": "string", "example": "iMac" }, "os": { "description": "The Operating System of the runner.", "type": "string", "example": "macos" }, "status": { "description": "The status of the runner.", "type": "string", "example": "online" }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } }, "ephemeral": { "type": "boolean" } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] } } } }, "examples": { "default": { "value": { "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "ephemeral": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "ephemeral": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/runners/downloads": { "get": { "summary": "List runner applications for an organization", "description": "Lists binaries for the runner application that you can download and run.\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.", "tags": [ "actions" ], "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Runner Application", "description": "Runner Application", "type": "object", "properties": { "os": { "type": "string" }, "architecture": { "type": "string" }, "download_url": { "type": "string" }, "filename": { "type": "string" }, "temp_download_token": { "description": "A short lived bearer token used to download the runner, if needed.", "type": "string" }, "sha256_checksum": { "type": "string" } }, "required": [ "os", "architecture", "download_url", "filename" ] } }, "examples": { "default": { "value": [ { "os": "osx", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", "filename": "actions-runner-osx-x64-2.164.0.tar.gz" }, { "os": "linux", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", "filename": "actions-runner-linux-x64-2.164.0.tar.gz" }, { "os": "linux", "architecture": "arm", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", "filename": "actions-runner-linux-arm-2.164.0.tar.gz" }, { "os": "win", "architecture": "x64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", "filename": "actions-runner-win-x64-2.164.0.zip" }, { "os": "linux", "architecture": "arm64", "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/runners/generate-jitconfig": { "post": { "summary": "Create configuration for a just-in-time runner for an organization", "description": "Generates a configuration that can be passed to the runner application at startup.\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.", "tags": [ "actions" ], "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "runner_group_id", "labels" ], "properties": { "name": { "type": "string", "description": "The name of the new runner." }, "runner_group_id": { "type": "integer", "description": "The ID of the runner group to register the runner to." }, "labels": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string" }, "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." }, "work_folder": { "type": "string", "description": "The working directory to be used for job execution, relative to the runner install directory.", "default": "_work" } } }, "examples": { "default": { "value": { "name": "New runner", "runner_group_id": 1, "labels": [ "self-hosted", "X64", "macOS", "no-gpu" ], "work_folder": "_work" } } } } } }, "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "runner", "encoded_jit_config" ], "properties": { "runner": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { "description": "The ID of the runner group.", "type": "integer", "example": 1 }, "name": { "description": "The name of the runner.", "type": "string", "example": "iMac" }, "os": { "description": "The Operating System of the runner.", "type": "string", "example": "macos" }, "status": { "description": "The status of the runner.", "type": "string", "example": "online" }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } }, "ephemeral": { "type": "boolean" } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] }, "encoded_jit_config": { "type": "string", "description": "The base64 encoded runner configuration." } } }, "examples": { "default": { "value": { "runner": { "id": 23, "name": "New runner", "os": "unknown", "status": "offline", "busy": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] }, "encoded_jit_config": "abc123" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for an organization", "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\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.", "tags": [ "actions" ], "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "Authentication Token", "description": "Authentication Token", "type": "object", "properties": { "token": { "description": "The token used for authentication", "type": "string", "example": "v1.1f699f1069f60xxx" }, "expires_at": { "description": "The time this token expires", "type": "string", "format": "date-time", "example": "2016-07-11T22:14:10Z" }, "permissions": { "type": "object", "example": { "issues": "read", "deployments": "write" } }, "repositories": { "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": "string", "example": "config.yaml", "nullable": true }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] } }, "required": [ "token", "expires_at" ] }, "examples": { "default": { "value": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-22T12:13:35.123-08:00" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for an organization", "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\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.", "tags": [ "actions" ], "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response", "content": { "application/json": { "schema": { "title": "Authentication Token", "description": "Authentication Token", "type": "object", "properties": { "token": { "description": "The token used for authentication", "type": "string", "example": "v1.1f699f1069f60xxx" }, "expires_at": { "description": "The time this token expires", "type": "string", "format": "date-time", "example": "2016-07-11T22:14:10Z" }, "permissions": { "type": "object", "example": { "issues": "read", "deployments": "write" } }, "repositories": { "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "example": 42, "type": "integer", "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "description": "The name of the repository.", "type": "string", "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "license": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "example": "mit" }, "name": { "type": "string", "example": "MIT License" }, "url": { "type": "string", "nullable": true, "format": "uri", "example": "https://api.github.com/licenses/mit" }, "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, "html_url": { "type": "string", "format": "uri" } }, "required": [ "key", "name", "url", "spdx_id", "node_id" ], "nullable": true }, "forks": { "type": "integer" }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" } }, "required": [ "admin", "pull", "push" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "description": "Whether the repository is private or public.", "default": false, "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string", "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string", "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string", "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", "format": "uri", "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string", "format": "uri", "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", "format": "uri", "example": "https://github.com", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer", "example": 9 }, "stargazers_count": { "type": "integer", "example": 80 }, "watchers_count": { "type": "integer", "example": 80 }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer", "example": 108 }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "example": "master" }, "open_issues_count": { "type": "integer", "example": 0 }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "example": true }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "example": true }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "example": true }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "example": true, "deprecated": true }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "example": true }, "archived": { "description": "Whether the repository is archived.", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "description": "Returns whether or not this repository disabled." }, "visibility": { "description": "The repository visibility: public, private, or internal.", "default": "public", "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "example": true }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "example": false }, "allow_update_branch": { "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", "default": false, "type": "boolean", "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, "squash_merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], "description": "The default value for a squash merge commit title:\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)." }, "squash_merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" ], "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." }, "merge_commit_title": { "type": "string", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], "description": "The 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)." }, "merge_commit_message": { "type": "string", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" ], "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." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "example": true }, "allow_forking": { "description": "Whether to allow forking this repo", "type": "boolean" }, "web_commit_signoff_required": { "description": "Whether to require contributors to sign off on web-based commits", "default": false, "type": "boolean" }, "open_issues": { "type": "integer" }, "watchers": { "type": "integer" }, "master_branch": { "type": "string" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:42Z\"" }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url", "clone_url", "default_branch", "forks", "forks_count", "git_url", "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", "homepage", "language", "archived", "disabled", "mirror_url", "open_issues", "open_issues_count", "license", "pushed_at", "size", "ssh_url", "stargazers_count", "svn_url", "watchers", "watchers_count", "created_at", "updated_at" ] } }, "single_file": { "type": "string", "example": "config.yaml", "nullable": true }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": [ "all", "selected" ] } }, "required": [ "token", "expires_at" ] }, "examples": { "default": { "value": { "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", "expires_at": "2020-01-29T12:13:35.123-08:00" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for an organization", "description": "Gets a specific self-hosted runner configured in an organization.\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.", "tags": [ "actions" ], "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Self hosted runners", "description": "A self hosted runner", "type": "object", "properties": { "id": { "description": "The ID of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { "description": "The ID of the runner group.", "type": "integer", "example": 1 }, "name": { "description": "The name of the runner.", "type": "string", "example": "iMac" }, "os": { "description": "The Operating System of the runner.", "type": "string", "example": "macos" }, "status": { "description": "The status of the runner.", "type": "string", "example": "online" }, "busy": { "type": "boolean" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } }, "ephemeral": { "type": "boolean" } }, "required": [ "id", "name", "os", "status", "busy", "labels" ] }, "examples": { "default": { "value": { "id": 23, "name": "MBP", "os": "macos", "status": "online", "busy": true, "ephemeral": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} }, "delete": { "summary": "Delete a self-hosted runner from an organization", "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\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.", "tags": [ "actions" ], "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/runners/{runner_id}/labels": { "get": { "summary": "List labels for a self-hosted runner for an organization", "description": "Lists all labels for a self-hosted runner configured in an organization.\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.", "tags": [ "actions" ], "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } }, "examples": { "default": { "value": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} }, "post": { "summary": "Add custom labels to a self-hosted runner for an organization", "description": "Adds custom labels to a self-hosted runner configured in an organization.\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.", "tags": [ "actions" ], "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "labels" ], "properties": { "labels": { "type": "array", "minItems": 1, "maxItems": 100, "description": "The names of the custom labels to add to the runner.", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "labels": [ "gpu", "accelerated" ] } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } }, "examples": { "default": { "value": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} }, "put": { "summary": "Set custom labels for a self-hosted runner for an organization", "description": "Remove all previous custom labels and set the new custom labels for a specific\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.", "tags": [ "actions" ], "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "labels" ], "properties": { "labels": { "type": "array", "minItems": 0, "maxItems": 100, "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", "items": { "type": "string" } } } }, "examples": { "default": { "value": { "labels": [ "gpu", "accelerated" ] } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } }, "examples": { "default": { "value": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} }, "delete": { "summary": "Remove all custom labels from a self-hosted runner for an organization", "description": "Remove all custom labels from a self-hosted runner configured in an\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.", "tags": [ "actions" ], "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } }, "examples": { "default": { "value": { "total_count": 3, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" } ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { "delete": { "summary": "Remove a custom label from a self-hosted runner for an organization", "description": "Remove a custom label from a self-hosted runner configured\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.", "tags": [ "actions" ], "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "name", "description": "The name of a self-hosted runner's custom label.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "labels" ], "properties": { "total_count": { "type": "integer" }, "labels": { "type": "array", "items": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the label." }, "name": { "type": "string", "description": "Name of the label." }, "type": { "type": "string", "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", "enum": [ "read-only", "custom" ] } }, "required": [ "name" ] } } } }, "examples": { "default": { "value": { "total_count": 4, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "self-hosted-runners" }, "x-octokit": {} } }, "/orgs/{org}/actions/secrets": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/secrets#list-organization-secrets" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Actions Secret for an Organization", "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "example": "SECRET_TOKEN", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a secret", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" } }, "required": [ "name", "created_at", "updated_at", "visibility" ] } } } }, "examples": { "default": { "value": { "total_count": 3, "secrets": [ { "name": "GIST_ID", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "private" }, { "name": "DEPLOY_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/actions/secrets/public-key": { "get": { "summary": "Get an organization public key", "description": "Gets your public key, which you need to encrypt secrets. You need to\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.", "tags": [ "actions" ], "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "ActionsPublicKey", "description": "The public key used for setting Actions Secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "example": "1234567" }, "key": { "description": "The Base64 encoded public key.", "type": "string", "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" }, "id": { "type": "integer", "example": 2 }, "url": { "type": "string", "example": "https://api.github.com/user/keys/2" }, "title": { "type": "string", "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" }, "created_at": { "type": "string", "example": "2011-01-26T19:01:12Z" } }, "required": [ "key_id", "key" ] }, "examples": { "default": { "value": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/actions/secrets/{secret_name}": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Actions Secret for an Organization", "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "example": "SECRET_TOKEN", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a secret", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" } }, "required": [ "name", "created_at", "updated_at", "visibility" ] }, "examples": { "default": { "value": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} }, "put": { "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). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "tags": [ "actions" ], "operationId": "actions/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "encrypted_value": { "type": "string", "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", "description": "ID of the key you used to encrypt the secret." }, "visibility": { "type": "string", "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", "enum": [ "all", "private", "selected" ] }, "selected_repository_ids": { "type": "array", "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] } } }, "required": [ "visibility" ] }, "examples": { "default": { "value": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ 1296269, 1296280 ] } } } } } }, "responses": { "201": { "description": "Response when creating a secret", "content": { "application/json": { "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false }, "examples": { "default": { "value": null } } } } }, "204": { "description": "Response when updating a secret" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "actions" ], "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/actions/secrets/{secret_name}/repositories": { "get": { "summary": "List selected repositories for an organization secret", "description": "Lists all repositories that have been selected when the `visibility`\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.", "tags": [ "actions" ], "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } }, "examples": { "default": { "value": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} }, "put": { "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.", "tags": [ "actions" ], "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_repository_ids": { "type": "array", "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/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.", "items": { "type": "integer" } } }, "required": [ "selected_repository_ids" ] }, "examples": { "default": { "value": { "selected_repository_ids": [ 64780797 ] } } } } } }, "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", "description": "Adds a repository to an organization secret when the `visibility` for\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.", "tags": [ "actions" ], "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No Content when repository was added to the selected list" }, "409": { "description": "Conflict when visibility type is not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "actions" ], "operationId": "actions/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response when repository was removed from the selected list" }, "409": { "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/actions/variables": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/list-org-variables", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#list-organization-variables" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "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).\"", "in": "query", "schema": { "type": "integer", "default": 10 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "variables" ], "properties": { "total_count": { "type": "integer" }, "variables": { "type": "array", "items": { "title": "Actions Variable for an Organization", "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { "name": { "description": "The name of the variable.", "example": "USERNAME", "type": "string" }, "value": { "description": "The value of the variable.", "example": "octocat", "type": "string" }, "created_at": { "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "example": "2019-01-24T22:45:36.000Z", "type": "string", "format": "date-time" }, "updated_at": { "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "example": "2019-01-24T22:45:36.000Z", "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a variable", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" } }, "required": [ "name", "value", "created_at", "updated_at", "visibility" ] } } } }, "examples": { "default": { "value": { "total_count": 3, "variables": [ { "name": "USERNAME", "value": "octocat", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "private" }, { "name": "ACTIONS_RUNNER_DEBUG", "value": true, "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, { "name": "ADMIN_EMAIL", "value": "octocat@github.com", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} }, "post": { "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.", "tags": [ "actions" ], "operationId": "actions/create-org-variable", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#create-an-organization-variable" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the variable." }, "value": { "type": "string", "description": "The value of the variable." }, "visibility": { "type": "string", "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", "enum": [ "all", "private", "selected" ] }, "selected_repository_ids": { "type": "array", "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", "items": { "type": "integer" } } }, "required": [ "name", "value", "visibility" ] }, "examples": { "default": { "value": { "name": "USERNAME", "value": "octocat", "visibility": "selected", "selected_repository_ids": [ 1296269, 1296280 ] } } } } } }, "responses": { "201": { "description": "Response when creating a variable", "content": { "application/json": { "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false }, "examples": { "default": { "value": null } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} } }, "/orgs/{org}/actions/variables/{name}": { "get": { "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.", "tags": [ "actions" ], "operationId": "actions/get-org-variable", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#get-an-organization-variable" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "description": "The name of the variable.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Actions Variable for an Organization", "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { "name": { "description": "The name of the variable.", "example": "USERNAME", "type": "string" }, "value": { "description": "The value of the variable.", "example": "octocat", "type": "string" }, "created_at": { "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "example": "2019-01-24T22:45:36.000Z", "type": "string", "format": "date-time" }, "updated_at": { "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "example": "2019-01-24T22:45:36.000Z", "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a variable", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" } }, "required": [ "name", "value", "created_at", "updated_at", "visibility" ] }, "examples": { "default": { "value": { "name": "USERNAME", "value": "octocat", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} }, "patch": { "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.", "tags": [ "actions" ], "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#update-an-organization-variable" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "description": "The name of the variable.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the variable." }, "value": { "type": "string", "description": "The value of the variable." }, "visibility": { "type": "string", "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", "enum": [ "all", "private", "selected" ] }, "selected_repository_ids": { "type": "array", "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", "items": { "type": "integer" } } } }, "examples": { "default": { "value": { "name": "USERNAME", "value": "octocat", "visibility": "selected", "selected_repository_ids": [ 1296269, 1296280 ] } } } } } }, "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "actions" ], "operationId": "actions/delete-org-variable", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "description": "The name of the variable.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} } }, "/orgs/{org}/actions/variables/{name}/repositories": { "get": { "summary": "List selected repositories for an organization variable", "description": "Lists all repositories that can access an organization variable\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.", "tags": [ "actions" ], "operationId": "actions/list-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "description": "The name of the variable.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } }, "examples": { "default": { "value": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] } } } } } }, "409": { "description": "Response when the visibility of the variable is not set to `selected`" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} }, "put": { "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.", "tags": [ "actions" ], "operationId": "actions/set-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "description": "The name of the variable.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_repository_ids": { "type": "array", "description": "The IDs of the repositories that can access the organization variable.", "items": { "type": "integer" } } }, "required": [ "selected_repository_ids" ] }, "examples": { "default": { "value": { "selected_repository_ids": [ 64780797 ] } } } } } }, "responses": { "204": { "description": "Response" }, "409": { "description": "Response when the visibility of the variable is not set to `selected`" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} } }, "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization variable", "description": "Adds a repository to an organization variable that is available to selected repositories.\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.", "tags": [ "actions" ], "operationId": "actions/add-selected-repo-to-org-variable", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "description": "The name of the variable.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" }, "409": { "description": "Response when the visibility of the variable is not set to `selected`" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "actions" ], "operationId": "actions/remove-selected-repo-from-org-variable", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "description": "The name of the variable.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response" }, "409": { "description": "Response when the visibility of the variable is not set to `selected`" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", "subcategory": "variables" }, "x-octokit": {} } }, "/orgs/{org}/artifacts/metadata/deployment-record": { "post": { "summary": "Create an artifact deployment record", "description": "Create or update deployment records for an artifact associated with an organization.\nThis endpoint allows you to record information about a specific artifact, such as its name, digest, environments, cluster, and deployment.", "tags": [ "orgs" ], "operationId": "orgs/create-artifact-deployment-record", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the artifact.", "minLength": 1, "example": "libfoo" }, "digest": { "type": "string", "description": "The hex encoded digest of the artifact.", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", "description": "The artifact version.", "minLength": 1, "maxLength": 100, "x-multi-segment": true, "example": "1.2.3" }, "status": { "type": "string", "description": "The status of the artifact. Can be either deployed or decommissioned.", "enum": [ "deployed", "decommissioned" ] }, "logical_environment": { "type": "string", "description": "The stage of the deployment." }, "physical_environment": { "type": "string", "description": "The physical region of the deployment." }, "cluster": { "type": "string", "description": "The deployment cluster." }, "deployment_name": { "type": "string", "description": "The name of the deployment." }, "tags": { "type": "object", "description": "The tags associated with the deployment.", "additionalProperties": { "type": "string" }, "maxProperties": 5 }, "runtime_risks": { "type": "array", "description": "A list of runtime risks associated with the deployment.", "maxItems": 4, "uniqueItems": true, "items": { "type": "string", "enum": [ "critical-resource", "internet-exposed", "lateral-movement", "sensitive-data" ] } }, "github_repository": { "type": "string", "description": "The name of the GitHub repository associated with the artifact. This should be used\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.", "minLength": 1, "maxLength": 100, "pattern": "^[A-Za-z0-9.\\-_]+$", "example": "my-github-repo" } }, "required": [ "name", "digest", "status", "logical_environment", "deployment_name" ] }, "examples": { "default": { "value": { "name": "awesome-image", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "status": "deployed", "logical_environment": "prod", "physical_environment": "pacific-east", "cluster": "moda-1", "deployment_name": "deployment-pod", "tags": { "data-access": "sensitive" } } } } } } }, "responses": { "200": { "description": "Artifact deployment record stored successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "description": "The number of deployment records created", "type": "integer" }, "deployment_records": { "type": "array", "items": { "title": "Artifact Deployment Record", "description": "Artifact Metadata Deployment Record", "type": "object", "properties": { "id": { "type": "integer" }, "digest": { "type": "string" }, "logical_environment": { "type": "string" }, "physical_environment": { "type": "string" }, "cluster": { "type": "string" }, "deployment_name": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "runtime_risks": { "type": "array", "description": "A list of runtime risks associated with the deployment.", "maxItems": 4, "uniqueItems": true, "items": { "type": "string", "enum": [ "critical-resource", "internet-exposed", "lateral-movement", "sensitive-data" ] } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "attestation_id": { "type": "integer", "description": "The ID of the provenance attestation associated with the deployment record.", "nullable": true } } } } } }, "examples": { "default": { "value": { "total_count": 1, "deployment_records": [ { "id": 123, "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "logical_environment": "prod", "physical_environment": "pacific-east", "cluster": "moda-1", "deployment_name": "prod-deployment", "tags": { "data": "sensitive" }, "created": "2011-01-26T19:14:43Z", "updated_at": "2011-01-26T19:14:43Z", "attestation_id": 456 } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "artifact-metadata" }, "x-octokit": {} } }, "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { "post": { "summary": "Set cluster deployment records", "description": "Set deployment records for a given cluster.", "tags": [ "orgs" ], "operationId": "orgs/set-cluster-deployment-records", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "path", "description": "The cluster name.", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-zA-Z0-9._-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "logical_environment": { "type": "string", "description": "The stage of the deployment." }, "physical_environment": { "type": "string", "description": "The physical region of the deployment." }, "deployments": { "type": "array", "description": "The list of deployments to record.", "items": { "type": "object", "maxLength": 100, "properties": { "name": { "type": "string", "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", "minLength": 1, "maxLength": 255 }, "digest": { "type": "string", "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", "minLength": 1, "maxLength": 100, "x-multi-segment": true, "example": "1.2.3" }, "status": { "type": "string", "description": "The deployment status of the artifact.", "enum": [ "deployed", "decommissioned" ] }, "deployment_name": { "type": "string", "description": "The 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}\n", "minLength": 1, "maxLength": 128 }, "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.", "minLength": 1, "maxLength": 100, "pattern": "^[A-Za-z0-9.\\-_]+$", "example": "my-github-repo" }, "tags": { "type": "object", "description": "Key-value pairs to tag the deployment record.", "additionalProperties": { "type": "string" } }, "runtime_risks": { "type": "array", "description": "A list of runtime risks associated with the deployment.", "maxItems": 4, "uniqueItems": true, "items": { "type": "string", "enum": [ "critical-resource", "internet-exposed", "lateral-movement", "sensitive-data" ] } } }, "required": [ "name", "deployment_name", "digest" ] } } }, "required": [ "logical_environment", "deployments" ] }, "examples": { "default": { "value": { "logical_environment": "prod", "physical_environment": "pacific-east", "deployments": [ { "name": "awesome-image", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "version": "2.1.0", "status": "deployed", "deployment_name": "deployment-pod", "tags": { "runtime-risk": "sensitive-data" } } ] } } } } } }, "responses": { "200": { "description": "Artifact deployment record stored successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "description": "The number of deployment records created", "type": "integer" }, "deployment_records": { "type": "array", "items": { "title": "Artifact Deployment Record", "description": "Artifact Metadata Deployment Record", "type": "object", "properties": { "id": { "type": "integer" }, "digest": { "type": "string" }, "logical_environment": { "type": "string" }, "physical_environment": { "type": "string" }, "cluster": { "type": "string" }, "deployment_name": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "runtime_risks": { "type": "array", "description": "A list of runtime risks associated with the deployment.", "maxItems": 4, "uniqueItems": true, "items": { "type": "string", "enum": [ "critical-resource", "internet-exposed", "lateral-movement", "sensitive-data" ] } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "attestation_id": { "type": "integer", "description": "The ID of the provenance attestation associated with the deployment record.", "nullable": true } } } } } }, "examples": { "default": { "value": { "total_count": 1, "deployment_records": [ { "id": 123, "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "logical_environment": "prod", "physical_environment": "pacific-east", "cluster": "moda-1", "deployment_name": "prod-deployment", "tags": { "data": "sensitive" }, "created": "2011-01-26T19:14:43Z", "updated_at": "2011-01-26T19:14:43Z", "attestation_id": 456 } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "artifact-metadata" }, "x-octokit": {} } }, "/orgs/{org}/artifacts/metadata/storage-record": { "post": { "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.", "tags": [ "orgs" ], "operationId": "orgs/create-artifact-storage-record", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the artifact.", "example": "libfoo", "minLength": 1 }, "digest": { "type": "string", "description": "The digest of the artifact (algorithm:hex-encoded-digest).", "example": "sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0...", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "version": { "type": "string", "description": "The artifact version.", "minLength": 1, "maxLength": 100, "x-multi-segment": true, "example": "1.2.3" }, "artifact_url": { "type": "string", "format": "uri", "pattern": "^https://", "description": "The URL where the artifact is stored.", "example": "https://reg.example.com/artifactory/bar/libfoo-1.2.3" }, "path": { "type": "string", "format": "uri", "description": "The path of the artifact.", "example": "com/github/bar/libfoo-1.2.3" }, "registry_url": { "type": "string", "format": "uri", "pattern": "^https://", "description": "The base URL of the artifact registry.", "example": "https://reg.example.com/artifactory/", "minLength": 1 }, "repository": { "type": "string", "description": "The repository name within the registry.", "example": "bar" }, "status": { "type": "string", "description": "The status of the artifact (e.g., active, inactive).", "example": "active", "enum": [ "active", "eol", "deleted" ], "default": "active" }, "github_repository": { "type": "string", "description": "The name of the GitHub repository associated with the artifact. This should be used\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.", "minLength": 1, "maxLength": 100, "pattern": "^[A-Za-z0-9.\\-_]+$", "example": "my-github-repo" } }, "required": [ "name", "digest", "registry_url" ] }, "examples": { "default": { "value": { "name": "libfoo", "version": "1.2.3", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", "registry_url": "https://reg.example.com/artifactory/", "repository": "bar", "status": "active" } } } } } }, "responses": { "200": { "description": "Artifact metadata storage record stored successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "type": "integer", "example": 1 }, "storage_records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "digest": { "type": "string" }, "artifact_url": { "type": "string", "nullable": true }, "registry_url": { "type": "string" }, "repository": { "type": "string", "nullable": true }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "examples": { "default": { "value": { "total_count": 1, "storage_records": [ { "name": "libfoo", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", "registry_url": "https://reg.example.com/artifactory/", "repository": "bar", "status": "active", "created_at": "2023-10-01T12:00:00Z", "updated_at": "2023-10-01T12:00:00Z" } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "artifact-metadata" }, "x-octokit": {} } }, "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": { "get": { "summary": "List artifact deployment records", "description": "List deployment records for an artifact metadata associated with an organization.", "tags": [ "orgs" ], "operationId": "orgs/list-artifact-deployment-records", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subject_digest", "description": "The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`.", "in": "path", "required": true, "schema": { "type": "string", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "description": "The number of deployment records for this digest and organization", "example": 3, "type": "integer" }, "deployment_records": { "type": "array", "items": { "title": "Artifact Deployment Record", "description": "Artifact Metadata Deployment Record", "type": "object", "properties": { "id": { "type": "integer" }, "digest": { "type": "string" }, "logical_environment": { "type": "string" }, "physical_environment": { "type": "string" }, "cluster": { "type": "string" }, "deployment_name": { "type": "string" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "runtime_risks": { "type": "array", "description": "A list of runtime risks associated with the deployment.", "maxItems": 4, "uniqueItems": true, "items": { "type": "string", "enum": [ "critical-resource", "internet-exposed", "lateral-movement", "sensitive-data" ] } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "attestation_id": { "type": "integer", "description": "The ID of the provenance attestation associated with the deployment record.", "nullable": true } } } } } }, "examples": { "default": { "value": { "total_count": 1, "deployment_records": [ { "id": 123, "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "logical_environment": "prod", "physical_environment": "pacific-east", "cluster": "moda-1", "deployment_name": "prod-deployment", "tags": { "data": "sensitive" }, "created": "2011-01-26T19:14:43Z", "updated_at": "2011-01-26T19:14:43Z", "attestation_id": 456 } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "artifact-metadata" }, "x-octokit": {} } }, "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": { "get": { "summary": "List artifact storage records", "description": "List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required.", "tags": [ "orgs" ], "operationId": "orgs/list-artifact-storage-records", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subject_digest", "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", "in": "path", "required": true, "example": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "schema": { "type": "string", "minLength": 71, "maxLength": 71, "pattern": "^sha256:[a-f0-9]{64}$" }, "x-multi-segment": true } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_count": { "description": "The number of storage records for this digest and organization", "example": 3, "type": "integer" }, "storage_records": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "digest": { "type": "string" }, "artifact_url": { "type": "string" }, "registry_url": { "type": "string" }, "repository": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } } } }, "examples": { "default": { "value": { "storage_records": [ { "name": "libfoo-1.2.3", "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", "registry_url": "https://reg.example.com/artifactory/", "repository": "bar", "status": "active", "created_at": "2023-10-01T12:00:00Z", "updated_at": "2023-10-01T12:00:00Z" } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "artifact-metadata" }, "x-octokit": {} } }, "/orgs/{org}/attestations/bulk-list": { "post": { "summary": "List attestations by bulk subject digests", "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\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).", "tags": [ "orgs" ], "operationId": "orgs/list-attestations-bulk", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subject_digests": { "type": "array", "items": { "type": "string" }, "description": "List of subject digests to fetch attestations for.", "minItems": 1, "maxItems": 1024 }, "predicate_type": { "type": "string", "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." } }, "required": [ "subject_digests" ] }, "examples": { "default": { "value": { "subject_digests": [ "sha256:abc123", "sha512:def456" ] } }, "withPredicateType": { "value": { "subject_digests": [ "sha256:abc123", "sha512:def456" ], "predicateType": "provenance" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "attestations_subject_digests": { "type": "object", "additionalProperties": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "bundle": { "type": "object", "properties": { "mediaType": { "type": "string" }, "verificationMaterial": { "type": "object", "properties": {}, "additionalProperties": true }, "dsseEnvelope": { "type": "object", "properties": {}, "additionalProperties": true } }, "description": "The bundle of the attestation." }, "repository_id": { "type": "integer" }, "bundle_url": { "type": "string" } } } }, "description": "Mapping of subject digest to bundles." }, "page_info": { "type": "object", "properties": { "has_next": { "type": "boolean", "description": "Indicates whether there is a next page." }, "has_previous": { "type": "boolean", "description": "Indicates whether there is a previous page." }, "next": { "type": "string", "description": "The cursor to the next page." }, "previous": { "type": "string", "description": "The cursor to the previous page." } }, "description": "Information about the current page." } } }, "examples": { "default": { "value": { "attestations_subject_digests": [ { "sha256:abc": [ { "bundle": { "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", "verificationMaterial": { "tlogEntries": [ { "logIndex": "97913980", "logId": { "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" }, "kindVersion": { "kind": "dsse", "version": "0.0.1" }, "integratedTime": "1716998992", "inclusionPromise": { "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" }, "inclusionProof": { "logIndex": "93750549", "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", "treeSize": "93750551", "hashes": [ "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" ], "checkpoint": { "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } ], "timestampVerificationData": {}, "certificate": { "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } }, "dsseEnvelope": { "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", "payloadType": "application/vnd.in-toto+json", "signatures": [ { "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" } ] } }, "repository_id": 1 }, { "bundle": { "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", "verificationMaterial": { "tlogEntries": [ { "logIndex": "97913980", "logId": { "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" }, "kindVersion": { "kind": "dsse", "version": "0.0.1" }, "integratedTime": "1716998992", "inclusionPromise": { "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" }, "inclusionProof": { "logIndex": "93750549", "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", "treeSize": "93750551", "hashes": [ "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" ], "checkpoint": { "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } ], "timestampVerificationData": {}, "certificate": { "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } }, "dsseEnvelope": { "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", "payloadType": "application/vnd.in-toto+json", "signatures": [ { "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" } ] } }, "repository_id": 1 } ] } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "attestations" }, "x-octokit": {} } }, "/orgs/{org}/attestations/delete-request": { "post": { "summary": "Delete attestations in bulk", "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", "tags": [ "orgs" ], "operationId": "orgs/delete-attestations-bulk", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "properties": { "subject_digests": { "type": "array", "items": { "type": "string" }, "description": "List of subject digests associated with the artifact attestations to delete.", "minItems": 1, "maxItems": 1024 } }, "required": [ "subject_digests" ] }, { "properties": { "attestation_ids": { "type": "array", "items": { "type": "integer" }, "description": "List of unique IDs associated with the artifact attestations to delete.", "minItems": 1, "maxItems": 1024 } }, "required": [ "attestation_ids" ] } ], "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." }, "examples": { "by-subject-digests": { "summary": "Delete by subject digests", "value": { "subject_digests": [ "sha256:abc123", "sha512:def456" ] } }, "by-attestation-ids": { "summary": "Delete by attestation IDs", "value": { "attestation_ids": [ 111, 222 ] } } } } } }, "responses": { "200": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "attestations" }, "x-octokit": {} } }, "/orgs/{org}/attestations/digest/{subject_digest}": { "delete": { "summary": "Delete attestations by subject digest", "description": "Delete an artifact attestation by subject digest.", "tags": [ "orgs" ], "operationId": "orgs/delete-attestations-by-subject-digest", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subject_digest", "description": "Subject Digest", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true } ], "responses": { "200": { "description": "Response" }, "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "attestations" }, "x-octokit": {} } }, "/orgs/{org}/attestations/repositories": { "get": { "summary": "List attestation repositories", "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", "tags": [ "orgs" ], "operationId": "orgs/list-attestation-repositories", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/attestations#list-attestation-repositories" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "predicate_type", "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } }, "examples": { "default": { "value": [ { "id": 123, "name": "foo" }, { "id": 456, "name": "bar" } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "attestations" }, "x-octokit": {} } }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", "tags": [ "orgs" ], "operationId": "orgs/delete-attestations-by-id", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attestation_id", "description": "Attestation ID", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response" }, "204": { "description": "Response" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "attestations" }, "x-octokit": {} } }, "/orgs/{org}/attestations/{subject_digest}": { "get": { "summary": "List attestations", "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\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).", "tags": [ "orgs" ], "operationId": "orgs/list-attestations", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/attestations#list-attestations" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subject_digest", "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true }, { "name": "predicate_type", "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "attestations": { "type": "array", "items": { "type": "object", "properties": { "bundle": { "type": "object", "properties": { "mediaType": { "type": "string" }, "verificationMaterial": { "type": "object", "properties": {}, "additionalProperties": true }, "dsseEnvelope": { "type": "object", "properties": {}, "additionalProperties": true } }, "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." }, "repository_id": { "type": "integer" }, "bundle_url": { "type": "string" }, "initiator": { "type": "string" } } } } } }, "examples": { "default": { "value": { "attestations": [ { "bundle": { "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", "verificationMaterial": { "tlogEntries": [ { "logIndex": "97913980", "logId": { "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" }, "kindVersion": { "kind": "dsse", "version": "0.0.1" }, "integratedTime": "1716998992", "inclusionPromise": { "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" }, "inclusionProof": { "logIndex": "93750549", "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", "treeSize": "93750551", "hashes": [ "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" ], "checkpoint": { "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } ], "timestampVerificationData": {}, "certificate": { "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } }, "dsseEnvelope": { "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", "payloadType": "application/vnd.in-toto+json", "signatures": [ { "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" } ] } }, "repository_id": 1 }, { "bundle": { "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", "verificationMaterial": { "tlogEntries": [ { "logIndex": "97913980", "logId": { "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" }, "kindVersion": { "kind": "dsse", "version": "0.0.1" }, "integratedTime": "1716998992", "inclusionPromise": { "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" }, "inclusionProof": { "logIndex": "93750549", "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", "treeSize": "93750551", "hashes": [ "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" ], "checkpoint": { "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" } }, "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" } ], "timestampVerificationData": {}, "certificate": { "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" } }, "dsseEnvelope": { "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", "payloadType": "application/vnd.in-toto+json", "signatures": [ { "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" } ] } }, "repository_id": 1 } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "attestations" }, "x-octokit": {} } }, "/orgs/{org}/blocks": { "get": { "summary": "List users blocked by an organization", "description": "List the users blocked by an organization.", "tags": [ "orgs" ], "operationId": "orgs/list-blocked-users", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "examples": { "default": { "value": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ] } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "blocking" }, "x-octokit": {} } }, "/orgs/{org}/blocks/{username}": { "get": { "summary": "Check if a user is blocked by an organization", "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", "tags": [ "orgs" ], "operationId": "orgs/check-blocked-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "If the user is blocked" }, "404": { "description": "If the user is not blocked", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "blocking" }, "x-octokit": {} }, "put": { "summary": "Block a user from an organization", "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", "tags": [ "orgs" ], "operationId": "orgs/block-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "blocking" }, "x-octokit": {} }, "delete": { "summary": "Unblock a user from an organization", "description": "Unblocks the given user on behalf of the specified organization.", "tags": [ "orgs" ], "operationId": "orgs/unblock-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "username", "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "blocking" }, "x-octokit": {} } }, "/orgs/{org}/campaigns": { "get": { "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.", "tags": [ "campaigns" ], "operationId": "campaigns/list-org-campaigns", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "direction", "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "state", "description": "If specified, only campaigns with this state will be returned.", "in": "query", "required": false, "schema": { "title": "Campaign state", "description": "Indicates whether a campaign is open or closed", "type": "string", "enum": [ "open", "closed" ] } }, { "name": "sort", "description": "The property by which to sort the results.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "ends_at", "published" ], "default": "created" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Campaign summary", "description": "The campaign metadata and alert stats.", "type": "object", "properties": { "number": { "type": "integer", "description": "The number of the newly created campaign" }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, "name": { "type": "string", "description": "The campaign name" }, "description": { "type": "string", "description": "The campaign description" }, "managers": { "description": "The campaign managers", "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "team_managers": { "description": "The campaign team managers", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "privacy": { "type": "string" }, "notification_setting": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 }, "parent": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VGVhbTE=" }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1" }, "members_url": { "type": "string", "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, "name": { "description": "Name of the team", "type": "string", "example": "Justice League" }, "description": { "description": "Description of the team", "type": "string", "nullable": true, "example": "A great team." }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "example": "admin" }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "example": "closed" }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "example": "notifications_enabled" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1/repos" }, "slug": { "type": "string", "example": "justice-league" }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "example": "uid=example,ou=users,dc=github,dc=com", "type": "string" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ], "nullable": true } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "published_at": { "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "ends_at": { "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "closed_at": { "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", "format": "date-time", "nullable": true }, "state": { "title": "Campaign state", "description": "Indicates whether a campaign is open or closed", "type": "string", "enum": [ "open", "closed" ] }, "contact_link": { "description": "The contact link of the campaign.", "type": "string", "format": "uri", "nullable": true }, "alert_stats": { "type": "object", "additionalProperties": false, "properties": { "open_count": { "type": "integer", "description": "The number of open alerts" }, "closed_count": { "type": "integer", "description": "The number of closed alerts" }, "in_progress_count": { "type": "integer", "description": "The number of in-progress alerts" } }, "required": [ "open_count", "closed_count", "in_progress_count" ] } }, "required": [ "number", "created_at", "updated_at", "description", "managers", "ends_at", "state", "contact_link" ] } }, "examples": { "default": { "value": [ { "number": 3, "created_at": "2024-02-14T12:29:18Z", "updated_at": "2024-02-14T12:29:18Z", "name": "Critical CodeQL alert", "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", "managers": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "ends_at": "2024-03-14T12:29:18Z", "closed_at": null, "state": "open" }, { "number": 4, "created_at": "2024-03-30T12:29:18Z", "updated_at": "2024-03-30T12:29:18Z", "name": "Mitre top 10 KEV", "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", "managers": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "ends_at": "2024-04-30T12:29:18Z", "closed_at": null, "state": "open" } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "campaigns", "subcategory": "campaigns" }, "x-octokit": {} }, "post": { "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.", "tags": [ "campaigns" ], "operationId": "campaigns/create-campaign", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the campaign", "type": "string", "minLength": 1, "maxLength": 50 }, "description": { "description": "A description for the campaign", "type": "string", "minLength": 1, "maxLength": 255 }, "managers": { "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", "type": "array", "maxItems": 10, "items": { "description": "The login of each manager", "type": "string" } }, "team_managers": { "description": "The slugs of the teams to set as the campaign managers.", "type": "array", "maxItems": 10, "items": { "description": "The slug of each team", "type": "string" } }, "ends_at": { "description": "The end date and time of the campaign. The date must be in the future.", "type": "string", "format": "date-time" }, "contact_link": { "description": "The contact link of the campaign. Must be a URI.", "type": "string", "format": "uri", "nullable": true }, "code_scanning_alerts": { "description": "The code scanning alerts to include in this campaign", "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "properties": { "repository_id": { "type": "integer", "description": "The repository id" }, "alert_numbers": { "type": "array", "description": "The alert numbers", "minItems": 1, "items": { "type": "integer" } } }, "required": [ "repository_id", "alert_numbers" ] }, "nullable": true }, "generate_issues": { "description": "If true, will automatically generate issues for the campaign. The default is false.", "type": "boolean", "default": false } }, "required": [ "name", "description", "ends_at" ], "oneOf": [ { "required": [ "code_scanning_alerts" ] }, { "required": [ "secret_scanning_alerts" ] } ] }, "examples": { "default": { "value": { "name": "Critical CodeQL alerts", "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", "managers": [ "octocat" ], "ends_at": "2024-03-14T00:00:00Z", "code_scanning_alerts": [ { "repository_id": 1296269, "alert_numbers": [ 1, 2 ] } ] } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Campaign summary", "description": "The campaign metadata and alert stats.", "type": "object", "properties": { "number": { "type": "integer", "description": "The number of the newly created campaign" }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, "name": { "type": "string", "description": "The campaign name" }, "description": { "type": "string", "description": "The campaign description" }, "managers": { "description": "The campaign managers", "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "team_managers": { "description": "The campaign team managers", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "privacy": { "type": "string" }, "notification_setting": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 }, "parent": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VGVhbTE=" }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1" }, "members_url": { "type": "string", "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, "name": { "description": "Name of the team", "type": "string", "example": "Justice League" }, "description": { "description": "Description of the team", "type": "string", "nullable": true, "example": "A great team." }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "example": "admin" }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "example": "closed" }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "example": "notifications_enabled" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1/repos" }, "slug": { "type": "string", "example": "justice-league" }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "example": "uid=example,ou=users,dc=github,dc=com", "type": "string" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ], "nullable": true } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "published_at": { "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "ends_at": { "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "closed_at": { "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", "format": "date-time", "nullable": true }, "state": { "title": "Campaign state", "description": "Indicates whether a campaign is open or closed", "type": "string", "enum": [ "open", "closed" ] }, "contact_link": { "description": "The contact link of the campaign.", "type": "string", "format": "uri", "nullable": true }, "alert_stats": { "type": "object", "additionalProperties": false, "properties": { "open_count": { "type": "integer", "description": "The number of open alerts" }, "closed_count": { "type": "integer", "description": "The number of closed alerts" }, "in_progress_count": { "type": "integer", "description": "The number of in-progress alerts" } }, "required": [ "open_count", "closed_count", "in_progress_count" ] } }, "required": [ "number", "created_at", "updated_at", "description", "managers", "ends_at", "state", "contact_link" ] }, "examples": { "default": { "value": { "number": 3, "created_at": "2024-02-14T12:29:18Z", "updated_at": "2024-02-14T12:29:18Z", "name": "Critical CodeQL alert", "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", "managers": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "published_at": "2024-02-14T12:29:18Z", "ends_at": "2024-03-14T12:29:18Z", "closed_at": null, "state": "open", "alert_stats": { "open_count": 10, "closed_count": 3, "in_progress_count": 3 } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "429": { "description": "Too Many Requests" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "campaigns", "subcategory": "campaigns" }, "x-octokit": {} } }, "/orgs/{org}/campaigns/{campaign_number}": { "get": { "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.", "tags": [ "campaigns" ], "operationId": "campaigns/get-campaign-summary", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "campaign_number", "description": "The campaign number.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Campaign summary", "description": "The campaign metadata and alert stats.", "type": "object", "properties": { "number": { "type": "integer", "description": "The number of the newly created campaign" }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, "name": { "type": "string", "description": "The campaign name" }, "description": { "type": "string", "description": "The campaign description" }, "managers": { "description": "The campaign managers", "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "team_managers": { "description": "The campaign team managers", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "privacy": { "type": "string" }, "notification_setting": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 }, "parent": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VGVhbTE=" }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1" }, "members_url": { "type": "string", "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, "name": { "description": "Name of the team", "type": "string", "example": "Justice League" }, "description": { "description": "Description of the team", "type": "string", "nullable": true, "example": "A great team." }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "example": "admin" }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "example": "closed" }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "example": "notifications_enabled" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1/repos" }, "slug": { "type": "string", "example": "justice-league" }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "example": "uid=example,ou=users,dc=github,dc=com", "type": "string" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ], "nullable": true } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "published_at": { "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "ends_at": { "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "closed_at": { "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", "format": "date-time", "nullable": true }, "state": { "title": "Campaign state", "description": "Indicates whether a campaign is open or closed", "type": "string", "enum": [ "open", "closed" ] }, "contact_link": { "description": "The contact link of the campaign.", "type": "string", "format": "uri", "nullable": true }, "alert_stats": { "type": "object", "additionalProperties": false, "properties": { "open_count": { "type": "integer", "description": "The number of open alerts" }, "closed_count": { "type": "integer", "description": "The number of closed alerts" }, "in_progress_count": { "type": "integer", "description": "The number of in-progress alerts" } }, "required": [ "open_count", "closed_count", "in_progress_count" ] } }, "required": [ "number", "created_at", "updated_at", "description", "managers", "ends_at", "state", "contact_link" ] }, "examples": { "default": { "value": { "number": 3, "created_at": "2024-02-14T12:29:18Z", "updated_at": "2024-02-14T12:29:18Z", "name": "Critical CodeQL alert", "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", "managers": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "published_at": "2024-02-14T12:29:18Z", "ends_at": "2024-03-14T12:29:18Z", "closed_at": null, "state": "open", "alert_stats": { "open_count": 10, "closed_count": 3, "in_progress_count": 3 } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "campaigns", "subcategory": "campaigns" }, "x-octokit": {} }, "patch": { "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.", "tags": [ "campaigns" ], "operationId": "campaigns/update-campaign", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "campaign_number", "description": "The campaign number.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the campaign", "type": "string", "minLength": 1, "maxLength": 50 }, "description": { "description": "A description for the campaign", "type": "string", "minLength": 1, "maxLength": 255 }, "managers": { "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", "type": "array", "maxItems": 10, "items": { "type": "string" } }, "team_managers": { "description": "The slugs of the teams to set as the campaign managers.", "type": "array", "maxItems": 10, "items": { "description": "The slug of each team", "type": "string" } }, "ends_at": { "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "contact_link": { "description": "The contact link of the campaign. Must be a URI.", "type": "string", "format": "uri", "nullable": true }, "state": { "title": "Campaign state", "description": "Indicates whether a campaign is open or closed", "type": "string", "enum": [ "open", "closed" ] } } }, "examples": { "default": { "value": { "name": "Critical CodeQL alerts" } } } } } }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Campaign summary", "description": "The campaign metadata and alert stats.", "type": "object", "properties": { "number": { "type": "integer", "description": "The number of the newly created campaign" }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, "updated_at": { "type": "string", "format": "date-time", "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, "name": { "type": "string", "description": "The campaign name" }, "description": { "type": "string", "description": "The campaign description" }, "managers": { "description": "The campaign managers", "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } }, "team_managers": { "description": "The campaign team managers", "type": "array", "items": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "privacy": { "type": "string" }, "notification_setting": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 }, "parent": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VGVhbTE=" }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1" }, "members_url": { "type": "string", "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, "name": { "description": "Name of the team", "type": "string", "example": "Justice League" }, "description": { "description": "Description of the team", "type": "string", "nullable": true, "example": "A great team." }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "example": "admin" }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "example": "closed" }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "example": "notifications_enabled" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1/repos" }, "slug": { "type": "string", "example": "justice-league" }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "example": "uid=example,ou=users,dc=github,dc=com", "type": "string" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ], "nullable": true } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "published_at": { "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "ends_at": { "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "closed_at": { "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", "format": "date-time", "nullable": true }, "state": { "title": "Campaign state", "description": "Indicates whether a campaign is open or closed", "type": "string", "enum": [ "open", "closed" ] }, "contact_link": { "description": "The contact link of the campaign.", "type": "string", "format": "uri", "nullable": true }, "alert_stats": { "type": "object", "additionalProperties": false, "properties": { "open_count": { "type": "integer", "description": "The number of open alerts" }, "closed_count": { "type": "integer", "description": "The number of closed alerts" }, "in_progress_count": { "type": "integer", "description": "The number of in-progress alerts" } }, "required": [ "open_count", "closed_count", "in_progress_count" ] } }, "required": [ "number", "created_at", "updated_at", "description", "managers", "ends_at", "state", "contact_link" ] }, "examples": { "default": { "value": { "number": 3, "created_at": "2024-02-14T12:29:18Z", "updated_at": "2024-02-14T12:29:18Z", "name": "Critical CodeQL alert", "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", "managers": [ { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false } ], "published_at": "2024-02-14T12:29:18Z", "ends_at": "2024-03-14T12:29:18Z", "closed_at": null, "state": "open", "alert_stats": { "open_count": 10, "closed_count": 3, "in_progress_count": 3 } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "campaigns", "subcategory": "campaigns" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "campaigns" ], "operationId": "campaigns/delete-campaign", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "campaign_number", "description": "The campaign number.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Deletion successful" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "campaigns", "subcategory": "campaigns" }, "x-octokit": {} } }, "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/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.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tool_name", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", "in": "query", "required": false, "schema": { "type": "string", "description": "The name of the tool used to generate the code scanning analysis." } }, { "name": "tool_guid", "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", "in": "query", "required": false, "schema": { "nullable": true, "type": "string", "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "direction", "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "state", "description": "If specified, only code scanning alerts with this state will be returned.", "in": "query", "required": false, "schema": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", "closed", "dismissed", "fixed" ] } }, { "name": "sort", "description": "The property by which to sort the results.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ], "default": "created" } }, { "name": "severity", "description": "If specified, only code scanning alerts with this severity will be returned.", "in": "query", "required": false, "schema": { "type": "string", "description": "Severity of a code scanning alert.", "enum": [ "critical", "high", "medium", "low", "warning", "note", "error" ] } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", "readOnly": true }, "state": { "type": "string", "description": "State of a code scanning alert.", "nullable": true, "enum": [ "open", "dismissed", "fixed" ] }, "fixed_at": { "type": "string", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true }, "dismissed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "dismissed_at": { "type": "string", "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true }, "dismissed_reason": { "type": "string", "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "nullable": true, "enum": [ "false positive", "won't fix", "used in tests" ] }, "dismissed_comment": { "type": "string", "description": "The dismissal comment associated with the dismissal of the alert.", "nullable": true, "maxLength": 280 }, "rule": { "type": "object", "properties": { "id": { "nullable": true, "type": "string", "description": "A unique identifier for the rule used to detect the alert." }, "name": { "type": "string", "description": "The name of the rule used to detect the alert." }, "severity": { "nullable": true, "type": "string", "description": "The severity of the alert.", "enum": [ "none", "note", "warning", "error" ] }, "security_severity_level": { "nullable": true, "type": "string", "description": "The security severity of the alert.", "enum": [ "low", "medium", "high", "critical" ] }, "description": { "type": "string", "description": "A short description of the rule used to detect the alert." }, "full_description": { "type": "string", "description": "A description of the rule used to detect the alert." }, "tags": { "nullable": true, "type": "array", "description": "A set of tags applicable for the rule.", "items": { "type": "string" } }, "help": { "nullable": true, "type": "string", "description": "Detailed documentation for the rule as GitHub Flavored Markdown." }, "help_uri": { "nullable": true, "type": "string", "description": "A link to the documentation for the rule used to detect the alert." } } }, "tool": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tool used to generate the code scanning analysis." }, "version": { "nullable": true, "type": "string", "description": "The version of the tool used to generate the code scanning analysis." }, "guid": { "nullable": true, "type": "string", "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } } }, "most_recent_instance": { "type": "object", "properties": { "ref": { "type": "string", "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." }, "analysis_key": { "type": "string", "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." }, "environment": { "type": "string", "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." }, "category": { "type": "string", "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." }, "state": { "type": "string", "description": "State of a code scanning alert.", "nullable": true, "enum": [ "open", "dismissed", "fixed" ] }, "commit_sha": { "type": "string" }, "message": { "type": "object", "properties": { "text": { "type": "string" } } }, "location": { "type": "object", "description": "Describe a region within a file for the alert.", "properties": { "path": { "type": "string" }, "start_line": { "type": "integer" }, "end_line": { "type": "integer" }, "start_column": { "type": "integer" }, "end_column": { "type": "integer" } } }, "html_url": { "type": "string" }, "classifications": { "type": "array", "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", "items": { "type": "string", "description": "A classification of the file. For example to identify it as generated.", "nullable": true, "enum": [ "source", "generated", "test", "library" ] } } } }, "repository": { "title": "Simple Repository", "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", "example": "Hello-World", "description": "The name of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", "nullable": true, "description": "The repository description." }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World", "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/contributors", "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/downloads", "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/events", "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/forks", "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/languages", "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/merges", "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscription", "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/tags", "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/teams", "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks", "description": "The API URL to list the hooks on the repository." } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "dismissal_approved_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] } } }, "required": [ "number", "created_at", "url", "html_url", "instances_url", "state", "dismissed_by", "dismissed_at", "dismissed_reason", "rule", "tool", "most_recent_instance", "repository" ] } }, "examples": { "default": { "value": [ { "number": 4, "created_at": "2020-02-13T12:29:18Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", "html_url": "https://github.com/octocat/hello-world/code-scanning/4", "state": "open", "dismissed_by": null, "dismissed_at": null, "dismissed_reason": null, "dismissed_comment": null, "rule": { "id": "js/zipslip", "severity": "error", "tags": [ "security", "external/cwe/cwe-022" ], "description": "Arbitrary file write during zip extraction", "name": "js/zipslip" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "open", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "spec-main/api-session-spec.ts", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [ "test" ] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } }, { "number": 3, "created_at": "2020-02-13T12:29:18Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", "html_url": "https://github.com/octocat/hello-world/code-scanning/3", "state": "dismissed", "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "dismissed_at": "2020-02-14T12:29:18Z", "dismissed_reason": "false positive", "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", "rule": { "id": "js/zipslip", "severity": "error", "tags": [ "security", "external/cwe/cwe-022" ], "description": "Arbitrary file write during zip extraction", "name": "js/zipslip" }, "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "most_recent_instance": { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "{}", "state": "open", "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", "message": { "text": "This path depends on a user-provided value." }, "location": { "path": "lib/ab12-gen.js", "start_line": 917, "end_line": 917, "start_column": 7, "end_column": 18 }, "classifications": [] }, "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } } ] } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "documentation_url": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-scanning", "subcategory": "code-scanning" }, "x-octokit": {} } }, "/orgs/{org}/code-security/configurations": { "get": { "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.", "tags": [ "code-security" ], "operationId": "code-security/get-configurations-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "target_type", "in": "query", "description": "The target type of the code security configuration", "required": false, "schema": { "type": "string", "enum": [ "global", "all" ], "default": "all" } }, { "name": "per_page", "in": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "required": false, "schema": { "type": "integer", "default": 30 } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } }, "examples": { "default": { "value": [ { "id": 17, "target_type": "global", "name": "GitHub recommended", "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_delagated_alert_dismissal": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", "secret_scanning_delegated_bypass_options": { "reviewers": [ { "security_configuration_id": 17, "reviewer_id": 5678, "reviewer_type": "TEAM" } ] }, "secret_scanning_validity_checks": "enabled", "secret_scanning_non_provider_patterns": "enabled", "secret_scanning_delegated_alert_dismissal": "not_set", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", "updated_at": "2023-12-04T15:58:07Z" }, { "id": 1326, "target_type": "organization", "name": "High risk settings", "description": "This is a code security configuration for octo-org high risk repositories", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "enabled", "code_scanning_default_setup": "enabled", "code_scanning_delagated_alert_dismissal": "enabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", "created_at": "2024-05-10T00:00:00Z", "updated_at": "2024-05-10T00:00:00Z" } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} }, "post": { "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.", "tags": [ "code-security" ], "operationId": "code-security/create-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "description": { "type": "string", "description": "A description of the code security configuration", "maxLength": 255 }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\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" ], "default": "disabled" }, "code_security": { "type": "string", "description": "The enablement status of GitHub Code Security features.", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ], "default": "enabled" }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", "default": false } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "code_scanning_options": { "type": "object", "description": "Security Configuration feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ], "default": "not_set" }, "secret_protection": { "type": "string", "description": "The enablement status of GitHub Secret Protection features.", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non provider patterns", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ], "default": "enforced" } }, "required": [ "name", "description" ] }, "examples": { "default": { "summary": "Example for a code security configuration", "value": { "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "secret_scanning": "enabled" } } } } } }, "responses": { "201": { "description": "Successfully created code security configuration", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_generic_secrets": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/orgs/{org}/code-security/configurations/defaults": { "get": { "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.", "tags": [ "code-security" ], "operationId": "code-security/get-default-configurations", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "description": "A list of default code security configurations", "items": { "type": "object", "properties": { "default_for_new_repos": { "enum": [ "public", "private_and_internal", "all" ], "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" }, "configuration": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } } }, "examples": { "default": { "value": [ { "default_for_new_repos": "public", "configuration": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "enabled", "secret_scanning_delegated_bypass_options": { "reviewers": [ { "security_configuration_id": 1325, "reviewer_id": 5678, "reviewer_type": "TEAM" } ] }, "secret_scanning_validity_checks": "enabled", "secret_scanning_non_provider_patterns": "enabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } }, { "default_for_new_repos": "private_and_internal", "configuration": { "id": 17, "target_type": "global", "name": "GitHub recommended", "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "not_set", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "secret_scanning": "enabled", "secret_scanning_push_protection": "enabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "private_vulnerability_reporting": "enabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", "created_at": "2023-12-04T15:58:07Z", "updated_at": "2023-12-04T15:58:07Z" } } ] } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/orgs/{org}/code-security/configurations/detach": { "delete": { "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.", "tags": [ "code-security" ], "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "selected_repository_ids": { "type": "array", "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", "minItems": 1, "maxItems": 250, "items": { "type": "integer", "description": "Unique identifier of the repository." } } } }, "examples": { "default": { "summary": "Example for detaching repositories from configurations.", "value": { "selected_repository_ids": [ 32, 91 ] } } } } } }, "responses": { "204": { "description": "A header with no content is returned." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/orgs/{org}/code-security/configurations/{configuration_id}": { "get": { "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.", "tags": [ "code-security" ], "operationId": "code-security/get-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_generic_secrets": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } }, "304": { "description": "Not modified" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} }, "patch": { "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.", "tags": [ "code-security" ], "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "description": { "type": "string", "description": "A description of the code security configuration", "maxLength": 255 }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\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_security": { "type": "string", "description": "The enablement status of GitHub Code Security features.", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ], "default": "disabled" }, "secret_protection": { "type": "string", "description": "The enablement status of GitHub Secret Protection features.", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] } } }, "examples": { "default": { "summary": "Example for updating a code security configuration", "value": { "name": "octo-org recommended settings v2", "secret_scanning": "disabled", "code_scanning_default_setup": "enabled" } } } } } }, "responses": { "200": { "description": "Response when a configuration is updated", "content": { "application/json": { "schema": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "examples": { "default": { "value": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings v2", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "enabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "disabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_generic_secrets": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } }, "204": { "description": "Response when no new updates are made" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "code-security" ], "operationId": "code-security/delete-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "A header with no content is returned." }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { "post": { "summary": "Attach a configuration to repositories", "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\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.", "tags": [ "code-security" ], "operationId": "code-security/attach-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "scope": { "type": "string", "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", "enum": [ "all", "all_without_configurations", "public", "private_or_internal", "selected" ] }, "selected_repository_ids": { "type": "array", "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", "items": { "type": "integer", "description": "Unique identifier of the repository." } } }, "required": [ "scope" ] }, "examples": { "default": { "summary": "Example for attaching a configuration to some repositories", "value": { "scope": "selected", "selected_repository_ids": [ 32, 91 ] } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "default": { "value": null } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { "put": { "summary": "Set a code security configuration as a default for an organization", "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\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.", "tags": [ "code-security" ], "operationId": "code-security/set-configuration-as-default", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "default_for_new_repos": { "type": "string", "description": "Specify which types of repository this security configuration should be applied to by default.", "enum": [ "all", "none", "private_and_internal", "public" ] } } }, "examples": { "default": { "summary": "Set this configuration to be enabled by default on all new repositories.", "value": { "default_for_new_repos": "all" } } } } } }, "responses": { "200": { "description": "Default successfully changed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "default_for_new_repos": { "type": "string", "description": "Specifies which types of repository this security configuration is applied to by default.", "enum": [ "all", "none", "private_and_internal", "public" ] }, "configuration": { "type": "object", "description": "A code security configuration", "properties": { "id": { "type": "integer", "description": "The ID of the code security configuration" }, "name": { "type": "string", "description": "The name of the code security configuration. Must be unique within the organization." }, "target_type": { "type": "string", "description": "The type of the code security configuration.", "enum": [ "global", "organization", "enterprise" ] }, "description": { "type": "string", "description": "A description of the code security configuration" }, "advanced_security": { "type": "string", "description": "The enablement status of GitHub Advanced Security", "enum": [ "enabled", "disabled", "code_security", "secret_protection" ] }, "dependency_graph": { "type": "string", "description": "The enablement status of Dependency Graph", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action": { "type": "string", "description": "The enablement status of Automatic dependency submission", "enum": [ "enabled", "disabled", "not_set" ] }, "dependency_graph_autosubmit_action_options": { "type": "object", "description": "Feature options for Automatic dependency submission", "properties": { "labeled_runners": { "type": "boolean", "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, "dependabot_alerts": { "type": "string", "description": "The enablement status of Dependabot alerts", "enum": [ "enabled", "disabled", "not_set" ] }, "dependabot_security_updates": { "type": "string", "description": "The enablement status of Dependabot security updates", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_options": { "type": "object", "description": "Feature options for code scanning", "nullable": true, "properties": { "allow_advanced": { "nullable": true, "type": "boolean", "description": "Whether to allow repos which use advanced setup" } } }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", "enum": [ "enabled", "disabled", "not_set" ] }, "code_scanning_default_setup_options": { "type": "object", "description": "Feature options for code scanning default setup", "nullable": true, "properties": { "runner_type": { "nullable": true, "type": "string", "enum": [ "standard", "labeled", "not_set" ], "description": "Whether to use labeled runners or standard GitHub runners." }, "runner_label": { "nullable": true, "type": "string", "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } } }, "code_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of code scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning": { "type": "string", "description": "The enablement status of secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_push_protection": { "type": "string", "description": "The enablement status of secret scanning push protection", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass": { "type": "string", "description": "The enablement status of secret scanning delegated bypass", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_bypass_options": { "type": "object", "description": "Feature options for secret scanning delegated bypass", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": [ "reviewer_id", "reviewer_type" ], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": [ "TEAM", "ROLE" ] } } } } } }, "secret_scanning_validity_checks": { "type": "string", "description": "The enablement status of secret scanning validity checks", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_non_provider_patterns": { "type": "string", "description": "The enablement status of secret scanning non-provider patterns", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_generic_secrets": { "type": "string", "description": "The enablement status of Copilot secret scanning", "enum": [ "enabled", "disabled", "not_set" ] }, "secret_scanning_delegated_alert_dismissal": { "type": "string", "description": "The enablement status of secret scanning delegated alert dismissal", "enum": [ "enabled", "disabled", "not_set" ] }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", "enum": [ "enabled", "disabled", "not_set" ] }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", "enum": [ "enforced", "unenforced" ] }, "url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", "description": "The URL of the configuration" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } } } }, "examples": { "default": { "value": { "default_for_new_repos": "all", "configuration": { "value": { "id": 1325, "target_type": "organization", "name": "octo-org recommended settings", "description": "This is a code security configuration for octo-org", "advanced_security": "enabled", "dependency_graph": "enabled", "dependency_graph_autosubmit_action": "enabled", "dependency_graph_autosubmit_action_options": { "labeled_runners": false }, "dependabot_alerts": "enabled", "dependabot_security_updates": "not_set", "code_scanning_default_setup": "disabled", "code_scanning_default_setup_options": { "runner_type": "not_set", "runner_label": null }, "code_scanning_options": { "allow_advanced": false }, "code_scanning_delegated_alert_dismissal": "disabled", "secret_scanning": "enabled", "secret_scanning_push_protection": "disabled", "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", "secret_scanning_generic_secrets": "disabled", "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", "created_at": "2024-05-01T00:00:00Z", "updated_at": "2024-05-01T00:00:00Z" } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { "get": { "summary": "Get repositories associated with a code security configuration", "description": "Lists the repositories associated with a code security configuration in an organization.\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.", "tags": [ "code-security" ], "operationId": "code-security/get-repositories-for-configuration", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configuration_id", "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { "type": "integer", "default": 30 } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "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`", "in": "query", "required": false, "schema": { "type": "string", "default": "all" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Repositories associated with a code security configuration and attachment status", "properties": { "status": { "type": "string", "description": "The attachment status of the code security configuration on the repository.", "enum": [ "attached", "attaching", "detached", "removed", "enforced", "failed", "updating", "removed_by_enterprise" ] }, "repository": { "title": "Simple Repository", "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", "example": "Hello-World", "description": "The name of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", "nullable": true, "description": "The repository description." }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World", "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/contributors", "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/downloads", "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/events", "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/forks", "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/languages", "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/merges", "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscription", "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/tags", "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/teams", "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks", "description": "The API URL to list the hooks on the repository." } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } }, "examples": { "default": { "summary": "Example of code security configuration repositories", "value": [ { "status": "attached", "repository": { "value": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } } } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-security", "subcategory": "configurations" }, "x-octokit": {} } }, "/orgs/{org}/codespaces": { "get": { "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.", "tags": [ "codespaces" ], "operationId": "codespaces/list-in-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization" }, "parameters": [ { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "codespaces" ], "properties": { "total_count": { "type": "integer" }, "codespaces": { "type": "array", "items": { "type": "object", "title": "Codespace", "description": "A codespace.", "properties": { "id": { "type": "integer", "format": "int64", "example": 1 }, "name": { "description": "Automatically generated name of this codespace.", "type": "string", "example": "monalisa-octocat-hello-world-g4wpq6h95q" }, "display_name": { "description": "Display name for this codespace.", "type": "string", "example": "bookish space pancake", "nullable": true }, "environment_id": { "description": "UUID identifying this codespace's environment.", "type": "string", "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "nullable": true }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "billable_owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] }, "machine": { "type": "object", "title": "Codespace machine", "description": "A description of the machine powering a codespace.", "properties": { "name": { "type": "string", "description": "The name of the machine.", "example": "standardLinux" }, "display_name": { "type": "string", "description": "The display name of the machine includes cores, memory, and storage.", "example": "4 cores, 16 GB RAM, 64 GB storage" }, "operating_system": { "type": "string", "description": "The operating system of the machine.", "example": "linux" }, "storage_in_bytes": { "type": "integer", "description": "How much storage is available to the codespace.", "example": 68719476736 }, "memory_in_bytes": { "type": "integer", "description": "How much memory is available to the codespace.", "example": 17179869184 }, "cpus": { "type": "integer", "description": "How many cores are available to the codespace.", "example": 4 }, "prebuild_availability": { "type": "string", "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", "example": "ready", "enum": [ "none", "ready", "in_progress" ], "nullable": true } }, "required": [ "name", "display_name", "operating_system", "storage_in_bytes", "memory_in_bytes", "cpus", "prebuild_availability" ], "nullable": true }, "devcontainer_path": { "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": "string", "example": ".devcontainer/example/devcontainer.json", "nullable": true }, "prebuild": { "description": "Whether the codespace was created from a prebuild.", "type": "boolean", "example": false, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z" }, "last_used_at": { "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z" }, "state": { "description": "State of this codespace.", "enum": [ "Unknown", "Created", "Queued", "Provisioning", "Available", "Awaiting", "Unavailable", "Deleted", "Moved", "Shutdown", "Archived", "Starting", "ShuttingDown", "Failed", "Exporting", "Updating", "Rebuilding" ], "example": "Available", "type": "string" }, "url": { "description": "API URL for this codespace.", "type": "string", "format": "uri" }, "git_status": { "description": "Details about the codespace's git repository.", "type": "object", "properties": { "ahead": { "description": "The number of commits the local repository is ahead of the remote.", "type": "integer", "example": 0 }, "behind": { "description": "The number of commits the local repository is behind the remote.", "type": "integer", "example": 0 }, "has_unpushed_changes": { "description": "Whether the local repository has unpushed changes.", "type": "boolean" }, "has_uncommitted_changes": { "description": "Whether the local repository has uncommitted changes.", "type": "boolean" }, "ref": { "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", "type": "string", "example": "main" } } }, "location": { "description": "The initally assigned location of a new codespace.", "enum": [ "EastUs", "SouthEastAsia", "WestEurope", "WestUs2" ], "example": "WestUs2", "type": "string" }, "idle_timeout_minutes": { "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", "type": "integer", "example": 60, "nullable": true }, "web_url": { "description": "URL to access this codespace on the web.", "type": "string", "format": "uri" }, "machines_url": { "description": "API URL to access available alternate machine types for this codespace.", "type": "string", "format": "uri" }, "start_url": { "description": "API URL to start this codespace.", "type": "string", "format": "uri" }, "stop_url": { "description": "API URL to stop this codespace.", "type": "string", "format": "uri" }, "publish_url": { "description": "API URL to publish this codespace to a new repository.", "type": "string", "format": "uri", "nullable": true }, "pulls_url": { "description": "API URL for the Pull Request associated with this codespace, if any.", "type": "string", "format": "uri", "nullable": true }, "recent_folders": { "type": "array", "items": { "type": "string" } }, "runtime_constraints": { "type": "object", "properties": { "allowed_port_privacy_settings": { "description": "The privacy settings a user can select from when forwarding a port.", "type": "array", "items": { "type": "string" }, "nullable": true } } }, "pending_operation": { "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", "type": "boolean", "nullable": true }, "pending_operation_disabled_reason": { "description": "Text to show user when codespace is disabled by a pending operation", "type": "string", "nullable": true }, "idle_timeout_notice": { "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", "type": "string", "nullable": true }, "retention_period_minutes": { "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", "type": "integer", "example": 60, "nullable": true }, "retention_expires_at": { "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": "string", "format": "date-time", "example": "2011-01-26T20:01:12Z", "nullable": true }, "last_known_stop_notice": { "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": "string", "example": "you've used 100% of your spending limit for Codespaces", "nullable": true } }, "required": [ "id", "name", "environment_id", "owner", "billable_owner", "repository", "machine", "prebuild", "created_at", "updated_at", "last_used_at", "state", "url", "git_status", "location", "idle_timeout_minutes", "web_url", "machines_url", "start_url", "stop_url", "pulls_url", "recent_folders" ] } } } }, "examples": { "default": { "value": { "total_count": 3, "codespaces": [ { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-3f89ada1j3", "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/foobar/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-f8adfad99a", "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", "recent_folders": [] } ] } } } } } }, "304": { "description": "Not modified" }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organizations" }, "x-octokit": { "changes": [ { "type": "PARAMETER", "date": "2022-07-01", "parameter": "org", "before": { "name": "org_id" } } ] } } }, "/orgs/{org}/codespaces/access": { "put": { "summary": "Manage access control for organization codespaces", "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/set-codespaces-access", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "visibility": { "type": "string", "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", "enum": [ "disabled", "selected_members", "all_members", "all_members_and_outside_collaborators" ] }, "selected_usernames": { "type": "array", "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", "items": { "type": "string" }, "maxItems": 100 } }, "required": [ "visibility" ] }, "examples": { "default": { "value": { "visibility": "selected_members", "selected_usernames": [ "johnDoe", "atomIO" ] } } } } } }, "responses": { "204": { "description": "Response when successfully modifying permissions." }, "304": { "description": "Not modified" }, "400": { "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organizations" }, "x-octokit": {} } }, "/orgs/{org}/codespaces/access/selected_users": { "post": { "summary": "Add users to Codespaces access for an organization", "description": "Codespaces for the specified users will be billed to the organization.\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.", "tags": [ "codespaces" ], "operationId": "codespaces/set-codespaces-access-users", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_usernames": { "type": "array", "description": "The usernames of the organization members whose codespaces be billed to the organization.", "items": { "type": "string" }, "maxItems": 100 } }, "required": [ "selected_usernames" ] }, "examples": { "default": { "value": { "selected_usernames": [ "johnDoe", "atomIO" ] } } } } } }, "responses": { "204": { "description": "Response when successfully modifying permissions." }, "304": { "description": "Not modified" }, "400": { "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organizations" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "codespaces" ], "operationId": "codespaces/delete-codespaces-access-users", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" }, "deprecated": true, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_usernames": { "type": "array", "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", "items": { "type": "string" }, "maxItems": 100 } }, "required": [ "selected_usernames" ] }, "examples": { "default": { "value": { "selected_usernames": [ "johnDoe", "atomIO" ] } } } } } }, "responses": { "204": { "description": "Response when successfully modifying permissions." }, "304": { "description": "Not modified" }, "400": { "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organizations" }, "x-octokit": {} } }, "/orgs/{org}/codespaces/secrets": { "get": { "summary": "List organization secrets", "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/list-org-secrets", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Codespaces Secret", "description": "Secrets for a GitHub Codespace.", "type": "object", "properties": { "name": { "description": "The name of the secret", "example": "SECRET_NAME", "type": "string" }, "created_at": { "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "updated_at": { "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "visibility": { "description": "The type of repositories in the organization that the secret is visible to", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", "type": "string", "format": "uri", "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" } }, "required": [ "name", "created_at", "updated_at", "visibility" ] } } } }, "examples": { "default": { "value": { "total_count": 2, "secrets": [ { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, { "name": "GIST_ID", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z", "visibility": "all" } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} } }, "/orgs/{org}/codespaces/secrets/public-key": { "get": { "summary": "Get an organization public key", "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], "operationId": "codespaces/get-org-public-key", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "CodespacesPublicKey", "description": "The public key used for setting Codespaces secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "example": "1234567" }, "key": { "description": "The Base64 encoded public key.", "type": "string", "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" }, "id": { "type": "integer", "example": 2 }, "url": { "type": "string", "example": "https://api.github.com/user/keys/2" }, "title": { "type": "string", "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" }, "created_at": { "type": "string", "example": "2011-01-26T19:01:12Z" } }, "required": [ "key_id", "key" ] }, "examples": { "default": { "value": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} } }, "/orgs/{org}/codespaces/secrets/{secret_name}": { "get": { "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.", "tags": [ "codespaces" ], "operationId": "codespaces/get-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Codespaces Secret", "description": "Secrets for a GitHub Codespace.", "type": "object", "properties": { "name": { "description": "The name of the secret", "example": "SECRET_NAME", "type": "string" }, "created_at": { "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "updated_at": { "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", "format": "date-time" }, "visibility": { "description": "The type of repositories in the organization that the secret is visible to", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", "type": "string", "format": "uri", "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" } }, "required": [ "name", "created_at", "updated_at", "visibility" ] }, "examples": { "default": { "value": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} }, "put": { "summary": "Create or update an organization secret", "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\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.", "tags": [ "codespaces" ], "operationId": "codespaces/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "encrypted_value": { "type": "string", "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", "description": "The ID of the key you used to encrypt the secret." }, "visibility": { "type": "string", "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", "enum": [ "all", "private", "selected" ] }, "selected_repository_ids": { "type": "array", "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/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": "integer" } } }, "required": [ "visibility" ] }, "examples": { "default": { "value": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ 1296269, 1296280 ] } } } } } }, "responses": { "201": { "description": "Response when creating a secret", "content": { "application/json": { "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false }, "examples": { "default": { "value": null } } } } }, "204": { "description": "Response when updating a secret" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "codespaces" ], "operationId": "codespaces/delete-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} } }, "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { "get": { "summary": "List selected repositories for an organization secret", "description": "Lists all repositories that have been selected when the `visibility`\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.", "tags": [ "codespaces" ], "operationId": "codespaces/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } }, "examples": { "default": { "value": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} }, "put": { "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.", "tags": [ "codespaces" ], "operationId": "codespaces/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_repository_ids": { "type": "array", "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/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": "integer" } } }, "required": [ "selected_repository_ids" ] }, "examples": { "default": { "value": { "selected_repository_ids": [ 64780797 ] } } } } } }, "responses": { "204": { "description": "Response" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} } }, "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/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.", "tags": [ "codespaces" ], "operationId": "codespaces/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No Content when repository was added to the selected list" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict when visibility type is not set to selected" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "codespaces" ], "operationId": "codespaces/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response when repository was removed from the selected list" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "409": { "description": "Conflict when visibility type not set to selected" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error", "description": "Validation Error", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "code" ], "properties": { "resource": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" }, "index": { "type": "integer" }, "value": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "array", "nullable": true, "items": { "type": "string" } } ] } } } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", "subcategory": "organization-secrets" }, "x-octokit": {} } }, "/orgs/{org}/copilot/billing": { "get": { "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.", "tags": [ "copilot" ], "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "Copilot Organization Details", "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", "properties": { "seat_breakdown": { "title": "Copilot Seat Breakdown", "description": "The breakdown of Copilot Business seats for the organization.", "type": "object", "properties": { "total": { "type": "integer", "description": "The total number of seats being billed for the organization as of the current billing cycle." }, "added_this_cycle": { "type": "integer", "description": "Seats added during the current billing cycle." }, "pending_cancellation": { "type": "integer", "description": "The number of seats that are pending cancellation at the end of the current billing cycle." }, "pending_invitation": { "type": "integer", "description": "The number of users who have been invited to receive a Copilot seat through this organization." }, "active_this_cycle": { "type": "integer", "description": "The number of seats that have used Copilot during the current billing cycle." }, "inactive_this_cycle": { "type": "integer", "description": "The number of seats that have not used Copilot during the current billing cycle." } } }, "public_code_suggestions": { "type": "string", "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", "enum": [ "allow", "block", "unconfigured" ] }, "ide_chat": { "type": "string", "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", "enum": [ "enabled", "disabled", "unconfigured" ] }, "platform_chat": { "type": "string", "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", "enum": [ "enabled", "disabled", "unconfigured" ] }, "cli": { "type": "string", "description": "The organization policy for allowing or disallowing Copilot in the CLI.", "enum": [ "enabled", "disabled", "unconfigured" ] }, "seat_management_setting": { "type": "string", "description": "The mode of assigning new seats.", "enum": [ "assign_all", "assign_selected", "disabled", "unconfigured" ] }, "plan_type": { "type": "string", "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", "enum": [ "business", "enterprise" ] } }, "required": [ "seat_breakdown", "public_code_suggestions", "seat_management_setting" ], "additionalProperties": true }, "examples": { "default": { "value": { "seat_breakdown": { "total": 12, "added_this_cycle": 9, "pending_invitation": 0, "pending_cancellation": 0, "active_this_cycle": 12, "inactive_this_cycle": 11 }, "seat_management_setting": "assign_selected", "ide_chat": "enabled", "platform_chat": "enabled", "cli": "enabled", "public_code_suggestions": "block", "plan_type": "business" } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "There is a problem with your account's associated payment method." }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" }, "x-octokit": {} } }, "/orgs/{org}/copilot/billing/seats": { "get": { "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.", "tags": [ "copilot" ], "operationId": "copilot/list-copilot-seats", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 50 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_seats": { "type": "integer", "description": "Total number of Copilot seats for the organization currently being billed." }, "seats": { "type": "array", "items": { "title": "Copilot Business Seat Detail", "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", "properties": { "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "organization": { "title": "Organization Simple", "description": "A GitHub organization.", "type": "object", "properties": { "login": { "type": "string", "example": "github" }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/repos" }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/orgs/github/events" }, "hooks_url": { "type": "string", "example": "https://api.github.com/orgs/github/hooks" }, "issues_url": { "type": "string", "example": "https://api.github.com/orgs/github/issues" }, "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, "public_members_url": { "type": "string", "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", "example": "https://github.com/images/error/octocat_happy.gif" }, "description": { "type": "string", "example": "A great organization", "nullable": true } }, "required": [ "login", "url", "id", "node_id", "repos_url", "events_url", "hooks_url", "issues_url", "members_url", "public_members_url", "avatar_url", "description" ], "nullable": true }, "assigning_team": { "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "privacy": { "type": "string" }, "notification_setting": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": [ "pull", "triage", "push", "maintain", "admin" ] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 }, "parent": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VGVhbTE=" }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1" }, "members_url": { "type": "string", "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, "name": { "description": "Name of the team", "type": "string", "example": "Justice League" }, "description": { "description": "Description of the team", "type": "string", "nullable": true, "example": "A great team." }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "example": "admin" }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "example": "closed" }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "example": "notifications_enabled" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/orgs/rails/teams/core" }, "repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/1/team/1/repos" }, "slug": { "type": "string", "example": "justice-league" }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "example": "uid=example,ou=users,dc=github,dc=com", "type": "string" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "example": 37 }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "example": 42 } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ], "nullable": true } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] }, { "title": "Enterprise Team", "description": "Group of enterprise owners and/or members", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "sync_to_organizations": { "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "disabled | all" }, "organization_selection_type": { "type": "string", "example": "disabled | selected | all" }, "group_id": { "nullable": true, "type": "string", "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, "group_name": { "nullable": true, "type": "string", "description": "Retired: this field will not be returned with GHEC enterprise teams.", "example": "Justice League" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/enterprises/dc/teams/justice-league" }, "members_url": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "url", "members_url", "name", "html_url", "slug", "created_at", "updated_at", "group_id" ] } ], "nullable": true }, "pending_cancellation_date": { "type": "string", "format": "date", "nullable": true, "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." }, "last_activity_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." }, "last_activity_editor": { "type": "string", "nullable": true, "description": "Last editor that was used by the user for a GitHub Copilot completion." }, "last_authenticated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." }, "updated_at": { "type": "string", "format": "date-time", "deprecated": true, "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." }, "plan_type": { "type": "string", "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", "enum": [ "business", "enterprise", "unknown" ] } }, "required": [ "created_at" ], "additionalProperties": false } } } }, "examples": { "default": { "value": { "total_seats": 2, "seats": [ { "created_at": "2021-08-03T18:00:00-06:00", "updated_at": "2021-09-23T15:00:00-06:00", "pending_cancellation_date": null, "last_activity_at": "2021-10-14T00:53:32-06:00", "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", "last_authenticated_at": "2021-10-14T00:53:32-06:00", "plan_type": "business", "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "assigning_team": { "id": 1, "node_id": "MDQ6VGVhbTE=", "url": "https://api.github.com/teams/1", "html_url": "https://github.com/orgs/github/teams/justice-league", "name": "Justice League", "slug": "justice-league", "description": "A great team.", "privacy": "closed", "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } }, { "created_at": "2021-09-23T18:00:00-06:00", "updated_at": "2021-09-23T15:00:00-06:00", "pending_cancellation_date": "2021-11-01", "last_activity_at": "2021-10-13T00:53:32-06:00", "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", "last_authenticated_at": "2021-10-14T00:53:32-06:00", "assignee": { "login": "octokitten", "id": 1, "node_id": "MDQ76VNlcjE=", "avatar_url": "https://github.com/images/error/octokitten_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octokitten", "html_url": "https://github.com/octokitten", "followers_url": "https://api.github.com/users/octokitten/followers", "following_url": "https://api.github.com/users/octokitten/following{/other_user}", "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", "organizations_url": "https://api.github.com/users/octokitten/orgs", "repos_url": "https://api.github.com/users/octokitten/repos", "events_url": "https://api.github.com/users/octokitten/events{/privacy}", "received_events_url": "https://api.github.com/users/octokitten/received_events", "type": "User", "site_admin": false } } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" }, "x-octokit": {} } }, "/orgs/{org}/copilot/billing/selected_teams": { "post": { "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.", "tags": [ "copilot" ], "operationId": "copilot/add-copilot-seats-for-teams", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_teams": { "type": "array", "description": "List of team names within the organization to which to grant access to GitHub Copilot.", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "selected_teams" ] }, "examples": { "default": { "value": { "selected_teams": [ "engteam1", "engteam2", "engteam3" ] } } } } }, "required": true }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" } }, "required": [ "seats_created" ] }, "examples": { "default": { "value": { "seats_created": 5 } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "copilot" ], "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_teams": { "type": "array", "description": "The names of teams from which to revoke access to GitHub Copilot.", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "selected_teams" ] }, "examples": { "default": { "value": { "selected_teams": [ "engteam1", "engteam2", "engteam3" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" } }, "required": [ "seats_cancelled" ] }, "examples": { "default": { "value": { "seats_cancelled": 5 } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" }, "x-octokit": {} } }, "/orgs/{org}/copilot/billing/selected_users": { "post": { "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.", "tags": [ "copilot" ], "operationId": "copilot/add-copilot-seats-for-users", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_usernames": { "type": "array", "description": "The usernames of the organization members to be granted access to GitHub Copilot.", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "selected_usernames" ] }, "examples": { "default": { "value": { "selected_usernames": [ "cooluser1", "hacker2", "octocat" ] } } } } }, "required": true }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" } }, "required": [ "seats_created" ] }, "examples": { "default": { "value": { "seats_created": 5 } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "copilot" ], "operationId": "copilot/cancel-copilot-seat-assignment-for-users", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_usernames": { "type": "array", "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "selected_usernames" ] }, "examples": { "default": { "value": { "selected_usernames": [ "cooluser1", "hacker2", "octocat" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" } }, "required": [ "seats_cancelled" ] }, "examples": { "default": { "value": { "seats_cancelled": 5 } } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" }, "x-octokit": {} } }, "/orgs/{org}/copilot/metrics": { "get": { "summary": "Get Copilot metrics for an organization", "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], "operationId": "copilot/copilot-metrics-for-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "since", "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "until", "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 100 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Copilot Usage Metrics", "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." }, "total_active_users": { "type": "integer", "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, "total_engaged_users": { "type": "integer", "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, "copilot_ide_code_completions": { "type": "object", "description": "Usage metrics for Copilot editor code completions in the IDE.", "nullable": true, "additionalProperties": true, "properties": { "total_engaged_users": { "type": "integer", "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." }, "languages": { "type": "array", "description": "Code completion metrics for active languages.", "items": { "type": "object", "description": "Usage metrics for a given language for the given editor for Copilot code completions.", "properties": { "name": { "type": "string", "description": "Name of the language used for Copilot code completion suggestions." }, "total_engaged_users": { "type": "integer", "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." } } } }, "editors": { "type": "array", "items": { "type": "object", "description": "Copilot code completion metrics for active editors.", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Name of the given editor." }, "total_engaged_users": { "type": "integer", "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." }, "models": { "type": "array", "description": "List of model metrics for custom models and the default model.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." }, "is_custom_model": { "type": "boolean", "description": "Indicates whether a model is custom or default." }, "custom_model_training_date": { "type": "string", "nullable": true, "description": "The training date for the custom model." }, "total_engaged_users": { "type": "integer", "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." }, "languages": { "type": "array", "description": "Code completion metrics for active languages, for the given editor.", "items": { "type": "object", "description": "Usage metrics for a given language for the given editor for Copilot code completions.", "properties": { "name": { "type": "string", "description": "Name of the language used for Copilot code completion suggestions, for the given editor." }, "total_engaged_users": { "type": "integer", "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." }, "total_code_suggestions": { "type": "integer", "description": "The number of Copilot code suggestions generated for the given editor, for the given language." }, "total_code_acceptances": { "type": "integer", "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." }, "total_code_lines_suggested": { "type": "integer", "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." }, "total_code_lines_accepted": { "type": "integer", "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." } } } } } } } } } } } }, "copilot_ide_chat": { "type": "object", "description": "Usage metrics for Copilot Chat in the IDE.", "nullable": true, "additionalProperties": true, "properties": { "total_engaged_users": { "type": "integer", "description": "Total number of users who prompted Copilot Chat in the IDE." }, "editors": { "type": "array", "items": { "type": "object", "description": "Copilot Chat metrics, for active editors.", "properties": { "name": { "type": "string", "description": "Name of the given editor." }, "total_engaged_users": { "type": "integer", "description": "The number of users who prompted Copilot Chat in the specified editor." }, "models": { "type": "array", "description": "List of model metrics for custom models and the default model.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." }, "is_custom_model": { "type": "boolean", "description": "Indicates whether a model is custom or default." }, "custom_model_training_date": { "type": "string", "nullable": true, "description": "The training date for the custom model." }, "total_engaged_users": { "type": "integer", "description": "The number of users who prompted Copilot Chat in the given editor and model." }, "total_chats": { "type": "integer", "description": "The total number of chats initiated by users in the given editor and model." }, "total_chat_insertion_events": { "type": "integer", "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." }, "total_chat_copy_events": { "type": "integer", "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." } } } } } } } } }, "copilot_dotcom_chat": { "type": "object", "description": "Usage metrics for Copilot Chat in GitHub.com", "nullable": true, "additionalProperties": true, "properties": { "total_engaged_users": { "type": "integer", "description": "Total number of users who prompted Copilot Chat on github.com at least once." }, "models": { "type": "array", "description": "List of model metrics for a custom models and the default model.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." }, "is_custom_model": { "type": "boolean", "description": "Indicates whether a model is custom or default." }, "custom_model_training_date": { "type": "string", "description": "The training date for the custom model (if applicable).", "nullable": true }, "total_engaged_users": { "type": "integer", "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." }, "total_chats": { "type": "integer", "description": "Total number of chats initiated by users on github.com." } } } } } }, "copilot_dotcom_pull_requests": { "type": "object", "description": "Usage metrics for Copilot for pull requests.", "nullable": true, "additionalProperties": true, "properties": { "total_engaged_users": { "type": "integer", "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." }, "repositories": { "type": "array", "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Repository name" }, "total_engaged_users": { "type": "integer", "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." }, "models": { "type": "array", "description": "List of model metrics for custom models and the default model.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." }, "is_custom_model": { "type": "boolean", "description": "Indicates whether a model is custom or default." }, "custom_model_training_date": { "type": "string", "nullable": true, "description": "The training date for the custom model." }, "total_pr_summaries_created": { "type": "integer", "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." }, "total_engaged_users": { "type": "integer", "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." } } } } } } } } } }, "required": [ "date" ], "additionalProperties": true } }, "examples": { "default": { "value": [ { "date": "2024-06-24", "total_active_users": 24, "total_engaged_users": 20, "copilot_ide_code_completions": { "total_engaged_users": 20, "languages": [ { "name": "python", "total_engaged_users": 10 }, { "name": "ruby", "total_engaged_users": 10 } ], "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 13, "languages": [ { "name": "python", "total_engaged_users": 6, "total_code_suggestions": 249, "total_code_acceptances": 123, "total_code_lines_suggested": 225, "total_code_lines_accepted": 135 }, { "name": "ruby", "total_engaged_users": 7, "total_code_suggestions": 496, "total_code_acceptances": 253, "total_code_lines_suggested": 520, "total_code_lines_accepted": 270 } ] } ] }, { "name": "neovim", "total_engaged_users": 7, "models": [ { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "languages": [ { "name": "typescript", "total_engaged_users": 3, "total_code_suggestions": 112, "total_code_acceptances": 56, "total_code_lines_suggested": 143, "total_code_lines_accepted": 61 }, { "name": "go", "total_engaged_users": 4, "total_code_suggestions": 132, "total_code_acceptances": 67, "total_code_lines_suggested": 154, "total_code_lines_accepted": 72 } ] } ] } ] }, "copilot_ide_chat": { "total_engaged_users": 13, "editors": [ { "name": "vscode", "total_engaged_users": 13, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 12, "total_chats": 45, "total_chat_insertion_events": 12, "total_chat_copy_events": 16 }, { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_engaged_users": 1, "total_chats": 10, "total_chat_insertion_events": 11, "total_chat_copy_events": 3 } ] } ] }, "copilot_dotcom_chat": { "total_engaged_users": 14, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_engaged_users": 14, "total_chats": 38 } ] }, "copilot_dotcom_pull_requests": { "total_engaged_users": 12, "repositories": [ { "name": "demo/repo1", "total_engaged_users": 8, "models": [ { "name": "default", "is_custom_model": false, "custom_model_training_date": null, "total_pr_summaries_created": 6, "total_engaged_users": 8 } ] }, { "name": "demo/repo2", "total_engaged_users": 4, "models": [ { "name": "a-custom-model", "is_custom_model": true, "custom_model_training_date": "2024-02-01", "total_pr_summaries_created": 10, "total_engaged_users": 4 } ] } ] } } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" }, "x-octokit": {} } }, "/orgs/{org}/dependabot/alerts": { "get": { "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.", "tags": [ "dependabot" ], "operationId": "dependabot/list-alerts-for-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "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" } }, { "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" } }, { "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" } }, { "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" } }, { "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- 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" } }, { "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" } }, { "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" } }, { "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": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "enum": [ "patch", "deployment" ] } } ] } }, { "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" } }, { "name": "scope", "in": "query", "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", "schema": { "type": "string", "enum": [ "development", "runtime" ] } }, { "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", "enum": [ "created", "updated", "epss_percentage" ], "default": "created" } }, { "name": "direction", "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "before", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "after", "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).\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "A Dependabot alert.", "properties": { "number": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "state": { "type": "string", "description": "The state of the Dependabot alert.", "readOnly": true, "enum": [ "auto_dismissed", "dismissed", "fixed", "open" ] }, "dependency": { "type": "object", "description": "Details for the vulnerable dependency.", "readOnly": true, "properties": { "package": { "type": "object", "description": "Details for the vulnerable package.", "readOnly": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "readOnly": true }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "required": [ "ecosystem", "name" ], "additionalProperties": false }, "manifest_path": { "type": "string", "description": "The full path to the dependency manifest file, relative to the root of the repository.", "readOnly": true }, "scope": { "type": "string", "description": "The execution scope of the vulnerable dependency.", "readOnly": true, "nullable": true, "enum": [ "development", "runtime" ] }, "relationship": { "type": "string", "description": "The vulnerable dependency's relationship to your project.\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.\n", "readOnly": true, "nullable": true, "enum": [ "unknown", "direct", "transitive" ] } } }, "security_advisory": { "type": "object", "description": "Details for the GitHub Security Advisory.", "readOnly": true, "properties": { "ghsa_id": { "type": "string", "description": "The unique GitHub Security Advisory ID assigned to the advisory.", "readOnly": true }, "cve_id": { "type": "string", "description": "The unique CVE ID assigned to the advisory.", "readOnly": true, "nullable": true }, "summary": { "type": "string", "description": "A short, plain text summary of the advisory.", "readOnly": true, "maxLength": 1024 }, "description": { "type": "string", "description": "A long-form Markdown-supported description of the advisory.", "readOnly": true }, "vulnerabilities": { "type": "array", "description": "Vulnerable version range information for the advisory.", "readOnly": true, "items": { "type": "object", "description": "Details pertaining to one vulnerable version range for the advisory.", "readOnly": true, "properties": { "package": { "type": "object", "description": "Details for the vulnerable package.", "readOnly": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "readOnly": true }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "required": [ "ecosystem", "name" ], "additionalProperties": false }, "severity": { "type": "string", "description": "The severity of the vulnerability.", "readOnly": true, "enum": [ "low", "medium", "high", "critical" ] }, "vulnerable_version_range": { "type": "string", "description": "Conditions that identify vulnerable versions of this vulnerability's package.", "readOnly": true }, "first_patched_version": { "type": "object", "description": "Details pertaining to the package version that patches this vulnerability.", "readOnly": true, "nullable": true, "properties": { "identifier": { "type": "string", "description": "The package version that patches this vulnerability.", "readOnly": true } }, "required": [ "identifier" ], "additionalProperties": false } }, "required": [ "package", "severity", "vulnerable_version_range", "first_patched_version" ], "additionalProperties": false } }, "severity": { "type": "string", "description": "The severity of the advisory.", "readOnly": true, "enum": [ "low", "medium", "high", "critical" ] }, "cvss": { "type": "object", "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", "readOnly": true, "properties": { "score": { "type": "number", "description": "The overall CVSS score of the advisory.", "minimum": 0, "maximum": 10, "readOnly": true }, "vector_string": { "type": "string", "description": "The full CVSS vector string for the advisory.", "readOnly": true, "nullable": true } }, "required": [ "score", "vector_string" ], "additionalProperties": false }, "cvss_severities": { "type": "object", "nullable": true, "properties": { "cvss_v3": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 3 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 3 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] }, "cvss_v4": { "type": "object", "nullable": true, "properties": { "vector_string": { "type": "string", "description": "The CVSS 4 vector string.", "nullable": true }, "score": { "type": "number", "description": "The CVSS 4 score.", "minimum": 0, "maximum": 10, "nullable": true, "readOnly": true } }, "required": [ "vector_string", "score" ] } } }, "epss": { "type": "object", "nullable": true, "readOnly": true, "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", "properties": { "percentage": { "type": "number", "minimum": 0, "maximum": 100 }, "percentile": { "type": "number", "minimum": 0, "maximum": 100 } } }, "cwes": { "type": "array", "description": "Details for the advisory pertaining to Common Weakness Enumeration.", "readOnly": true, "items": { "type": "object", "description": "A CWE weakness assigned to the advisory.", "readOnly": true, "properties": { "cwe_id": { "type": "string", "description": "The unique CWE ID.", "readOnly": true }, "name": { "type": "string", "description": "The short, plain text name of the CWE.", "readOnly": true } }, "required": [ "cwe_id", "name" ], "additionalProperties": false } }, "identifiers": { "type": "array", "description": "Values that identify this advisory among security information sources.", "readOnly": true, "items": { "type": "object", "description": "An advisory identifier.", "readOnly": true, "properties": { "type": { "type": "string", "description": "The type of advisory identifier.", "readOnly": true, "enum": [ "CVE", "GHSA" ] }, "value": { "type": "string", "description": "The value of the advisory identifer.", "readOnly": true } }, "required": [ "value", "type" ], "additionalProperties": false } }, "references": { "type": "array", "description": "Links to additional advisory information.", "readOnly": true, "items": { "type": "object", "description": "A link to additional advisory information.", "readOnly": true, "properties": { "url": { "type": "string", "description": "The URL of the reference.", "format": "uri", "readOnly": true } }, "required": [ "url" ], "additionalProperties": false } }, "published_at": { "type": "string", "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "withdrawn_at": { "type": "string", "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true } }, "required": [ "ghsa_id", "cve_id", "summary", "description", "vulnerabilities", "severity", "cvss", "cwes", "identifiers", "references", "published_at", "updated_at", "withdrawn_at" ], "additionalProperties": false }, "security_vulnerability": { "type": "object", "description": "Details pertaining to one vulnerable version range for the advisory.", "readOnly": true, "properties": { "package": { "type": "object", "description": "Details for the vulnerable package.", "readOnly": true, "properties": { "ecosystem": { "type": "string", "description": "The package's language or package management ecosystem.", "readOnly": true }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "required": [ "ecosystem", "name" ], "additionalProperties": false }, "severity": { "type": "string", "description": "The severity of the vulnerability.", "readOnly": true, "enum": [ "low", "medium", "high", "critical" ] }, "vulnerable_version_range": { "type": "string", "description": "Conditions that identify vulnerable versions of this vulnerability's package.", "readOnly": true }, "first_patched_version": { "type": "object", "description": "Details pertaining to the package version that patches this vulnerability.", "readOnly": true, "nullable": true, "properties": { "identifier": { "type": "string", "description": "The package version that patches this vulnerability.", "readOnly": true } }, "required": [ "identifier" ], "additionalProperties": false } }, "required": [ "package", "severity", "vulnerable_version_range", "first_patched_version" ], "additionalProperties": false }, "url": { "type": "string", "description": "The REST API URL of the alert resource.", "format": "uri", "readOnly": true }, "html_url": { "type": "string", "description": "The GitHub URL of the alert resource.", "format": "uri", "readOnly": true }, "created_at": { "type": "string", "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dismissed_at": { "type": "string", "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true }, "dismissed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "dismissed_reason": { "type": "string", "description": "The reason that the alert was dismissed.", "nullable": true, "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk" ] }, "dismissed_comment": { "type": "string", "description": "An optional comment associated with the alert's dismissal.", "nullable": true, "maxLength": 280 }, "fixed_at": { "type": "string", "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true }, "auto_dismissed_at": { "type": "string", "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true, "nullable": true }, "dismissal_request": { "title": "Dependabot alert dismissal request", "description": "Information about an active dismissal request for this Dependabot alert.", "type": "object", "nullable": true, "properties": { "id": { "type": "integer", "description": "The unique identifier of the dismissal request." }, "status": { "type": "string", "description": "The current status of the dismissal request.", "enum": [ "pending", "approved", "rejected", "cancelled" ] }, "requester": { "type": "object", "description": "The user who requested the dismissal.", "properties": { "id": { "type": "integer", "description": "The unique identifier of the user." }, "login": { "type": "string", "description": "The login name of the user." } } }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time when the dismissal request was created." }, "url": { "type": "string", "format": "uri", "description": "The API URL to get more information about this dismissal request." } } }, "repository": { "title": "Simple Repository", "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", "example": "Hello-World", "description": "The name of the repository." }, "full_name": { "type": "string", "example": "octocat/Hello-World", "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World", "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", "nullable": true, "description": "The repository description." }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World", "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/contributors", "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/deployments", "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/downloads", "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/events", "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/forks", "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/languages", "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/merges", "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/subscription", "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/tags", "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/teams", "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World/hooks", "description": "The API URL to list the hooks on the repository." } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } }, "required": [ "number", "state", "dependency", "security_advisory", "security_vulnerability", "url", "html_url", "created_at", "updated_at", "dismissed_at", "dismissed_by", "dismissed_reason", "dismissed_comment", "fixed_at", "repository" ], "additionalProperties": false } }, "examples": { "default": { "value": [ { "number": 2, "state": "dismissed", "dependency": { "package": { "ecosystem": "pip", "name": "django" }, "manifest_path": "path/to/requirements.txt", "scope": "runtime" }, "security_advisory": { "ghsa_id": "GHSA-rf4j-j272-fj86", "cve_id": "CVE-2018-6188", "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", "vulnerabilities": [ { "package": { "ecosystem": "pip", "name": "django" }, "severity": "high", "vulnerable_version_range": ">= 2.0.0, < 2.0.2", "first_patched_version": { "identifier": "2.0.2" } }, { "package": { "ecosystem": "pip", "name": "django" }, "severity": "high", "vulnerable_version_range": ">= 1.11.8, < 1.11.10", "first_patched_version": { "identifier": "1.11.10" } } ], "severity": "high", "cvss": { "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, "cvss_v4": { "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", "score": 8.7 } }, "epss": [ { "percentage": 0.00045, "percentile": "0.16001e0" } ], "cwes": [ { "cwe_id": "CWE-200", "name": "Exposure of Sensitive Information to an Unauthorized Actor" } ], "identifiers": [ { "type": "GHSA", "value": "GHSA-rf4j-j272-fj86" }, { "type": "CVE", "value": "CVE-2018-6188" } ], "references": [ { "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" }, { "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" }, { "url": "https://usn.ubuntu.com/3559-1/" }, { "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" }, { "url": "http://www.securitytracker.com/id/1040422" } ], "published_at": "2018-10-03T21:13:54Z", "updated_at": "2022-04-26T18:35:37Z", "withdrawn_at": null }, "security_vulnerability": { "package": { "ecosystem": "pip", "name": "django" }, "severity": "high", "vulnerable_version_range": ">= 2.0.0, < 2.0.2", "first_patched_version": { "identifier": "2.0.2" } }, "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", "created_at": "2022-06-15T07:43:03Z", "updated_at": "2022-08-23T14:29:47Z", "dismissed_at": "2022-08-23T14:29:47Z", "dismissed_by": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "dismissed_reason": "tolerable_risk", "dismissed_comment": "This alert is accurate but we use a sanitizer.", "fixed_at": null, "repository": { "id": 217723378, "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", "name": "octo-repo", "full_name": "octo-org/octo-repo", "owner": { "login": "octo-org", "id": 6811672, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octo-org", "html_url": "https://github.com/octo-org", "followers_url": "https://api.github.com/users/octo-org/followers", "following_url": "https://api.github.com/users/octo-org/following{/other_user}", "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", "organizations_url": "https://api.github.com/users/octo-org/orgs", "repos_url": "https://api.github.com/users/octo-org/repos", "events_url": "https://api.github.com/users/octo-org/events{/privacy}", "received_events_url": "https://api.github.com/users/octo-org/received_events", "type": "Organization", "site_admin": false }, "private": true, "html_url": "https://github.com/octo-org/octo-repo", "description": null, "fork": false, "url": "https://api.github.com/repos/octo-org/octo-repo", "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" } }, { "number": 1, "state": "open", "dependency": { "package": { "ecosystem": "pip", "name": "ansible" }, "manifest_path": "path/to/requirements.txt", "scope": "runtime" }, "security_advisory": { "ghsa_id": "GHSA-8f4m-hccc-8qph", "cve_id": "CVE-2021-20191", "summary": "Insertion of Sensitive Information into Log File in ansible", "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", "vulnerabilities": [ { "package": { "ecosystem": "pip", "name": "ansible" }, "severity": "medium", "vulnerable_version_range": ">= 2.9.0, < 2.9.18", "first_patched_version": { "identifier": "2.9.18" } }, { "package": { "ecosystem": "pip", "name": "ansible" }, "severity": "medium", "vulnerable_version_range": "< 2.8.19", "first_patched_version": { "identifier": "2.8.19" } }, { "package": { "ecosystem": "pip", "name": "ansible" }, "severity": "medium", "vulnerable_version_range": ">= 2.10.0, < 2.10.7", "first_patched_version": { "identifier": "2.10.7" } } ], "severity": "medium", "cvss": { "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, "cvss_v4": { "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", "score": 8.5 } }, "cwes": [ { "cwe_id": "CWE-532", "name": "Insertion of Sensitive Information into Log File" } ], "identifiers": [ { "type": "GHSA", "value": "GHSA-8f4m-hccc-8qph" }, { "type": "CVE", "value": "CVE-2021-20191" } ], "references": [ { "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" }, { "url": "https://access.redhat.com/security/cve/cve-2021-20191" }, { "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" } ], "published_at": "2021-06-01T17:38:00Z", "updated_at": "2021-08-12T23:06:00Z", "withdrawn_at": null }, "security_vulnerability": { "package": { "ecosystem": "pip", "name": "ansible" }, "severity": "medium", "vulnerable_version_range": "< 2.8.19", "first_patched_version": { "identifier": "2.8.19" } }, "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", "created_at": "2022-06-14T15:21:52Z", "updated_at": "2022-06-14T15:21:52Z", "dismissed_at": null, "dismissed_by": null, "dismissed_reason": null, "dismissed_comment": null, "fixed_at": null, "repository": { "id": 664700648, "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", "name": "hello-world", "full_name": "octo-org/hello-world", "owner": { "login": "octo-org", "id": 6811672, "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", "gravatar_id": "", "url": "https://api.github.com/users/octo-org", "html_url": "https://github.com/octo-org", "followers_url": "https://api.github.com/users/octo-org/followers", "following_url": "https://api.github.com/users/octo-org/following{/other_user}", "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", "organizations_url": "https://api.github.com/users/octo-org/orgs", "repos_url": "https://api.github.com/users/octo-org/repos", "events_url": "https://api.github.com/users/octo-org/events{/privacy}", "received_events_url": "https://api.github.com/users/octo-org/received_events", "type": "Organization", "site_admin": false }, "private": true, "html_url": "https://github.com/octo-org/hello-world", "description": null, "fork": false, "url": "https://api.github.com/repos/octo-org/hello-world", "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", "events_url": "https://api.github.com/repos/octo-org/hello-world/events", "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" } } ] } } } } }, "304": { "description": "Not modified" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } }, "application/scim+json": { "schema": { "title": "Scim Error", "description": "Scim Error", "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "documentation_url": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "status": { "type": "integer" }, "scimType": { "type": "string", "nullable": true }, "schemas": { "type": "array", "items": { "type": "string" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { "title": "Validation Error Simple", "description": "Validation Error Simple", "type": "object", "required": [ "message", "documentation_url" ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "alerts" }, "x-octokit": {} } }, "/orgs/{org}/dependabot/secrets": { "get": { "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.", "tags": [ "dependabot" ], "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "secrets" ], "properties": { "total_count": { "type": "integer" }, "secrets": { "type": "array", "items": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "example": "SECRET_TOKEN", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a secret", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" } }, "required": [ "name", "created_at", "updated_at", "visibility" ] } } } }, "examples": { "default": { "value": { "total_count": 3, "secrets": [ { "name": "MY_ARTIFACTORY_PASSWORD", "created_at": "2021-08-10T14:59:22Z", "updated_at": "2021-12-10T14:59:22Z", "visibility": "private" }, { "name": "NPM_TOKEN", "created_at": "2021-08-10T14:59:22Z", "updated_at": "2021-12-10T14:59:22Z", "visibility": "all" }, { "name": "GH_TOKEN", "created_at": "2021-08-10T14:59:22Z", "updated_at": "2021-12-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" } ] } } } } }, "headers": { "Link": { "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/dependabot/secrets/public-key": { "get": { "summary": "Get an organization public key", "description": "Gets your public key, which you need to encrypt secrets. You need to\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.", "tags": [ "dependabot" ], "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "DependabotPublicKey", "description": "The public key used for setting Dependabot Secrets.", "type": "object", "properties": { "key_id": { "description": "The identifier for the key.", "type": "string", "example": "1234567" }, "key": { "description": "The Base64 encoded public key.", "type": "string", "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" } }, "required": [ "key_id", "key" ] }, "examples": { "default": { "value": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/dependabot/secrets/{secret_name}": { "get": { "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.", "tags": [ "dependabot" ], "operationId": "dependabot/get-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { "name": { "description": "The name of the secret.", "example": "SECRET_TOKEN", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "visibility": { "description": "Visibility of a secret", "enum": [ "all", "private", "selected" ], "type": "string" }, "selected_repositories_url": { "type": "string", "format": "uri", "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" } }, "required": [ "name", "created_at", "updated_at", "visibility" ] }, "examples": { "default": { "value": { "name": "NPM_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} }, "put": { "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). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "tags": [ "dependabot" ], "operationId": "dependabot/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "encrypted_value": { "type": "string", "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", "description": "ID of the key you used to encrypt the secret." }, "visibility": { "type": "string", "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", "enum": [ "all", "private", "selected" ] }, "selected_repository_ids": { "type": "array", "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } } }, "required": [ "visibility" ] }, "examples": { "default": { "value": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ "1296269", "1296280" ] } } } } } }, "responses": { "201": { "description": "Response when creating a secret", "content": { "application/json": { "schema": { "title": "Empty Object", "description": "An object without any properties.", "type": "object", "properties": {}, "additionalProperties": false }, "examples": { "default": { "value": null } } } } }, "204": { "description": "Response when updating a secret" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "dependabot" ], "operationId": "dependabot/delete-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { "get": { "summary": "List selected repositories for an organization secret", "description": "Lists all repositories that have been selected when the `visibility`\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.", "tags": [ "dependabot" ], "operationId": "dependabot/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "total_count", "repositories" ], "properties": { "total_count": { "type": "integer" }, "repositories": { "type": "array", "items": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ] } } } }, "examples": { "default": { "value": { "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} }, "put": { "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.", "tags": [ "dependabot" ], "operationId": "dependabot/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "selected_repository_ids": { "type": "array", "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/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": "integer" } } }, "required": [ "selected_repository_ids" ] }, "examples": { "default": { "value": { "selected_repository_ids": [ 64780797 ] } } } } } }, "responses": { "204": { "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", "description": "Adds a repository to an organization secret when the `visibility` for\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.", "tags": [ "dependabot" ], "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No Content when repository was added to the selected list" }, "409": { "description": "Conflict when visibility type is not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} }, "delete": { "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.", "tags": [ "dependabot" ], "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secret_name", "description": "The name of the secret.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Response when repository was removed from the selected list" }, "409": { "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "dependabot", "subcategory": "secrets" }, "x-octokit": {} } }, "/orgs/{org}/docker/conflicts": { "get": { "summary": "Get list of conflicting packages during Docker migration for organization", "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "tags": [ "packages" ], "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Package", "description": "A software package", "type": "object", "properties": { "id": { "description": "Unique identifier of the package.", "type": "integer", "example": 1 }, "name": { "description": "The name of the package.", "type": "string", "example": "super-linter" }, "package_type": { "type": "string", "example": "docker", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "url": { "type": "string", "example": "https://api.github.com/orgs/github/packages/container/super-linter" }, "html_url": { "type": "string", "example": "https://github.com/orgs/github/packages/container/package/super-linter" }, "version_count": { "description": "The number of versions of the package.", "type": "integer", "example": 1 }, "visibility": { "type": "string", "example": "private", "enum": [ "private", "public" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ] }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", "nullable": true }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { "type": "string" }, "mirror_url": { "type": "string", "nullable": true }, "hooks_url": { "type": "string", "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { "type": "string" }, "homepage": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "forks_count": { "type": "integer" }, "stargazers_count": { "type": "integer" }, "watchers_count": { "type": "integer" }, "size": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "type": "integer" }, "default_branch": { "type": "string" }, "open_issues_count": { "type": "integer" }, "is_template": { "type": "boolean" }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "type": "boolean" }, "has_projects": { "type": "boolean" }, "has_wiki": { "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean" }, "has_discussions": { "type": "boolean" }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:06:43Z", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:01:12Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2011-01-26T19:14:43Z", "nullable": true }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "example": "admin" }, "temp_clone_token": { "type": "string" }, "delete_branch_on_merge": { "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" }, "code_of_conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "example": "contributor_covenant" }, "name": { "type": "string", "example": "Contributor Covenant" }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, "body": { "type": "string", "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "url", "html_url", "key", "name" ] }, "license": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": "string" }, "node_id": { "type": "string" } }, "nullable": true }, "forks": { "type": "integer", "example": 0 }, "open_issues": { "type": "integer", "example": 0 }, "watchers": { "type": "integer", "example": 0 }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "example": false }, "security_and_analysis": { "nullable": true, "type": "object", "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_push_protection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "enabled", "disabled" ] } } } } }, "custom_properties": { "type": "object", "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", "additionalProperties": true } }, "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "node_id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ], "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "package_type", "visibility", "url", "html_url", "version_count", "created_at", "updated_at" ] } }, "examples": { "default": { "value": [ { "id": 197, "name": "hello_docker", "package_type": "container", "owner": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "version_count": 1, "visibility": "private", "url": "https://api.github.com/orgs/github/packages/container/hello_docker", "created_at": "2020-05-19T22:19:11Z", "updated_at": "2020-05-19T22:19:11Z", "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" }, { "id": 198, "name": "goodbye_docker", "package_type": "container", "owner": { "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", "followers_url": "https://api.github.com/users/github/followers", "following_url": "https://api.github.com/users/github/following{/other_user}", "gists_url": "https://api.github.com/users/github/gists{/gist_id}", "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/github/subscriptions", "organizations_url": "https://api.github.com/users/github/orgs", "repos_url": "https://api.github.com/users/github/repos", "events_url": "https://api.github.com/users/github/events{/privacy}", "received_events_url": "https://api.github.com/users/github/received_events", "type": "Organization", "site_admin": false }, "version_count": 2, "visibility": "private", "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", "created_at": "2020-05-20T22:19:11Z", "updated_at": "2020-05-20T22:19:11Z", "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" } ] } } } } }, "401": { "description": "Requires authentication", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "Basic Error", "description": "Basic Error", "type": "object", "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string" } } } } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "packages", "subcategory": "packages" }, "x-octokit": {} } }, "/orgs/{org}/events": { "get": { "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.", "tags": [ "activity" ], "operationId": "activity/list-public-org-events", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" }, "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 30 } }, { "name": "page", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Event", "description": "Event", "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "nullable": true }, "actor": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "repo": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "name", "url" ] }, "org": { "title": "Actor", "description": "Actor", "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "display_login": { "type": "string" }, "gravatar_id": { "type": "string", "nullable": true }, "url": { "type": "string", "format": "uri" }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "login", "gravatar_id", "url", "avatar_url" ] }, "payload": { "oneOf": [ { "title": "CreateEvent", "type": "object", "properties": { "ref": { "type": "string" }, "ref_type": { "type": "string" }, "full_ref": { "type": "string" }, "master_branch": { "type": "string" }, "description": { "type": "string", "nullable": true }, "pusher_type": { "type": "string" } }, "required": [ "ref", "ref_type", "full_ref", "master_branch", "pusher_type" ] }, { "title": "DeleteEvent", "type": "object", "properties": { "ref": { "type": "string" }, "ref_type": { "type": "string" }, "full_ref": { "type": "string" }, "pusher_type": { "type": "string" } }, "required": [ "ref", "ref_type", "full_ref", "pusher_type" ] }, { "title": "DiscussionEvent", "type": "object", "properties": { "action": { "type": "string" }, "discussion": { "title": "Discussion", "description": "A Discussion in a repository.", "type": "object", "properties": { "active_lock_reason": { "type": "string", "nullable": true }, "answer_chosen_at": { "type": "string", "nullable": true }, "answer_chosen_by": { "title": "User", "type": "object", "nullable": true, "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "Bot", "User", "Organization" ] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": [ "login", "id" ] }, "answer_html_url": { "type": "string", "nullable": true }, "author_association": { "title": "AuthorAssociation", "description": "How the author is associated with the repository.", "type": "string", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ] }, "body": { "type": "string" }, "category": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "emoji": { "type": "string" }, "id": { "type": "integer" }, "is_answerable": { "type": "boolean" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "repository_id": { "type": "integer" }, "slug": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "repository_id", "emoji", "name", "description", "created_at", "updated_at", "slug", "is_answerable" ] }, "comments": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "html_url": { "type": "string" }, "id": { "type": "integer" }, "locked": { "type": "boolean" }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "reactions": { "title": "Reactions", "type": "object", "properties": { "+1": { "type": "integer" }, "-1": { "type": "integer" }, "confused": { "type": "integer" }, "eyes": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "laugh": { "type": "integer" }, "rocket": { "type": "integer" }, "total_count": { "type": "integer" }, "url": { "type": "string", "format": "uri" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "repository_url": { "type": "string" }, "state": { "type": "string", "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", "enum": [ "open", "closed", "locked", "converting", "transferring" ] }, "state_reason": { "description": "The reason for the current state", "example": "resolved", "type": "string", "nullable": true, "enum": [ "resolved", "outdated", "duplicate", "reopened" ] }, "timeline_url": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "user": { "title": "User", "type": "object", "nullable": true, "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "nullable": true }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": [ "Bot", "User", "Organization" ] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": [ "login", "id" ] }, "labels": { "type": "array", "items": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 }, "node_id": { "type": "string", "example": "MDU6TGFiZWwyMDgwNDU5NDY=" }, "url": { "description": "URL for the label", "example": "https://api.github.com/repositories/42/labels/bug", "type": "string", "format": "uri" }, "name": { "description": "The name of the label.", "example": "bug", "type": "string" }, "description": { "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "example": "FFFFFF", "type": "string" }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default" ] } } }, "required": [ "repository_url", "category", "answer_html_url", "answer_chosen_at", "answer_chosen_by", "html_url", "id", "node_id", "number", "title", "user", "state", "state_reason", "locked", "comments", "created_at", "updated_at", "active_lock_reason", "body" ] } }, "required": [ "action", "discussion" ] }, { "title": "IssuesEvent", "type": "object", "properties": { "action": { "type": "string" }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "example": 42, "type": "integer" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "example": "open", "type": "string" }, "state_reason": { "description": "The reason for the current state", "example": "not_planned", "type": "string", "nullable": true, "enum": [ "completed", "reopened", "not_planned", "duplicate" ] }, "title": { "description": "Title of the issue", "example": "Widget creation fails in Safari on OS X 10.8", "type": "string" }, "body": { "description": "Contents of the issue", "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", "type": "string", "nullable": true }, "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "example": [ "bug", "registration" ], "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "default": { "type": "boolean" } } } ] } }, "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/received_events" }, "type": { "type": "string", "example": "User" }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" }, "user_view_type": { "type": "string", "example": "public" } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_url", "gravatar_id", "html_url", "id", "node_id", "login", "organizations_url", "received_events_url", "repos_url", "site_admin", "starred_url", "subscriptions_url", "type", "url" ], "nullable": true }, "assignees": { "type": "array", "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "email": { "nullable": true, "type": "string" }, "login": { "type": "string", "example": "octocat" }, "id": { "type": "integer", "format": "int64", "example": 1 }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, "avatar_url": { "type": "string", "format": "uri", "example": "https://github.com/images/error/octocat_happy.gif" }, "gravatar_id": { "type": "string", "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, "url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", "example": "https://github.com/octocat" }, "followers_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/followers" }, "following_url": { "type": "string", "example": "https://api.github.com/users/octocat/following{/other_user}" }, "gists_url": { "type": "string", "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, "starred_url": { "type": "string", "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, "subscriptions_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/subscriptions" }, "organizations_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/orgs" }, "repos_url": { "type": "string", "format": "uri", "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", "example": "https://api.github.com/users/octocat/events{/privacy}" }, "received_events_url": {