The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
One of asc (ascending) or desc (descending).
Can be one of created, updated, number.
Set to open, closed, fixed, or dismissed` to list code scanning alerts in a specific state.
Response
", "example": [ { "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", "fixed_at": null, "dismissed_by": null, "dismissed_at": null, "dismissed_reason": 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", "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" }, { "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", "fixed_at": null, "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", "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", "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" } ] } } ], "previews": [], "descriptionHTML": "Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint with private repos, the public_repo scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the security_events read\npermission to use this endpoint.
The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "title": "Get a code scanning alert", "category": "code-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "alert_number", "in": "path", "required": true, "schema": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "descriptionHTML": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Response
", "example": { "number": 42, "created_at": "2020-06-19T11:21:34Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", "html_url": "https://github.com/octocat/hello-world/code-scanning/42", "state": "dismissed", "fixed_at": null, "dismissed_by": { "login": "octocat", "id": 54933897, "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", "rule": { "id": "js/zipslip", "severity": "error", "security_severity_level": "high", "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", "name": "js/zipslip", "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", "tags": [ "security", "external/cwe/cwe-022" ], "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." }, "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", "environment": "{}", "state": "dismissed", "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/42/instances" } } } ], "previews": [], "descriptionHTML": "Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.
Deprecation notice:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "title": "Update a code scanning alert", "category": "code-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "alert_number", "in": "path", "required": true, "schema": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "descriptionHTML": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.
Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The dismissal note associated with the dismissal of the alert.
", "maxLength": 280, "name": "dismissed_note", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "The dismissal note associated with the dismissal of the alert.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", "dismissed_reason": "false positive", "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." }, "parameters": { "owner": "OWNER", "repo": "REPO", "alert_number": "ALERT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "number": 42, "created_at": "2020-08-25T21:28:36Z", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", "html_url": "https://github.com/octocat/hello-world/code-scanning/42", "state": "dismissed", "fixed_at": null, "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-09-02T22:34:56Z", "dismissed_reason": "false positive", "rule": { "id": "js/zipslip", "severity": "error", "security_severity_level": "high", "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", "name": "js/zipslip", "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", "tags": [ "security", "external/cwe/cwe-022" ], "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." }, "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", "environment": "{}", "state": "dismissed", "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/42/instances" } } } ], "previews": [], "descriptionHTML": "Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.
OK
" }, { "httpStatusCode": "403", "description": "Response if the repository is archived or if github advanced security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "title": "List instances of a code scanning alert", "category": "code-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "alert_number", "in": "path", "required": true, "schema": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "descriptionHTML": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "ref", "in": "query", "required": false, "schema": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Response
", "example": [ { "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", "state": "open", "fixed_at": null, "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": [ "library" ] }, { "ref": "refs/pull/3740/merge", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "fixed", "fixed_at": "2020-02-14T12:29:18Z", "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", "message": { "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." }, "location": { "path": "app/script.js", "start_line": 2, "end_line": 2, "start_column": 10, "end_column": 50 }, "classifications": [ "source" ] } ] } } ], "previews": [], "descriptionHTML": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", "title": "List code scanning analyses for a repository", "category": "code-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "tool_name", "in": "query", "required": false, "schema": { "type": "string", "description": "The name of the tool used to generate the code scanning analysis." }, "descriptionHTML": "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.
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.
Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "ref", "in": "query", "required": false, "schema": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.
Filter analyses belonging to the same SARIF upload.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "ref": "refs/heads/main", "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, "id": 201, "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "deletable": true, "warning": "" }, { "ref": "refs/heads/my-branch", "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, "id": 200, "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200", "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582", "tool": { "name": "Python Security Analysis", "guid": null, "version": "1.2.0" }, "deletable": true, "warning": "" } ] } } ], "previews": [], "descriptionHTML": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.
The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
You must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "title": "Get a code scanning analysis for a repository", "category": "code-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "analysis_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
Default response
", "example": { "ref": "refs/heads/main", "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, "id": 3602840, "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "tool": { "name": "CodeQL", "guid": null, "version": "2.4.0" }, "deletable": true, "warning": "" } } } ], "previews": [], "descriptionHTML": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.\nGitHub Apps must have the security_events read permission to use this endpoint.
The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.
\nThe rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.
If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "title": "Delete a code scanning analysis from a repository", "category": "code-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "analysis_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.
Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to true, you'll get a 400 response with the message: Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.
Default response
", "example": { "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Response if the repository is archived or if github advanced security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "descriptionHTML": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.
You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.
\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:
\n\"deletable\": true\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:
\n- \n
ref\ntool\nanalysis_key\nenvironment\n
If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:
\nAnalysis specified is not deletable.\nThe response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.
As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:
\nOuter loop:
\n- \n
- \n
List the analyses for the repository, filtered by tool.
\n \n - \n
Parse this list to find a deletable analysis. If found:
\nInner loop:
\n- \n
- Delete the identified analysis. \n
- Parse the response for the value of
confirm_delete_urland, if found, use this in the next iteration. \n
\n
The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
Required. The SHA of the commit to which the analysis you are uploading relates.
", "type": "string", "minLength": 40, "maxLength": 40, "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", "rawType": "string", "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.
Required. A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"
The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
", "type": "string", "format": "uri", "examples": [ "file:///github/workspace/" ], "name": "checkout_uri", "in": "body", "rawType": "string", "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", "childParamsGroups": [] }, { "description": "The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.
Default response
", "example": { "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request if the sarif field is invalid
" }, { "httpStatusCode": "403", "description": "Response if the repository is archived or if github advanced security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "413", "description": "Payload Too Large if the sarif field is too large
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint for private repositories. You can also use tokens with the public_repo scope for public repositories only. GitHub Apps must have the security_events write permission to use this endpoint.
There are two places where you can upload code scanning results.
\n- \n
- If you upload to a pull request, for example
--ref refs/pull/42/mergeor--ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\" \n - If you upload to a branch, for example
--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\" \n
You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
\nThe 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
The SARIF ID obtained after uploading.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "sarif_id": "SARIF_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "processing_status": "complete", "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" } } } ], "previews": [], "descriptionHTML": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.
OK
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", "description": "Not Found if the sarif id does not match any upload
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "code-scanning" } ] }, "codes-of-conduct": { "codes-of-conduct": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/codes_of_conduct", "title": "Get all codes of conduct", "category": "codes-of-conduct", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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/" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "codes-of-conduct" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/codes_of_conduct/{key}", "title": "Get a code of conduct", "category": "codes-of-conduct", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key": "KEY" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n", "html_url": "http://contributor-covenant.org/version/1/4/" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codes-of-conduct" } ] }, "codespaces": { "codespaces": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces", "title": "List codespaces in a repository for the authenticated user", "category": "codespaces", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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": 2, "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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-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": [] } ] } } } ], "previews": [], "descriptionHTML": "Lists the codespaces associated to a specified repository and the authenticated user.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/codespaces", "title": "Create a codespace in a repository", "category": "codespaces", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "description": "Git ref (typically a branch name) for this codespace
", "type": "string", "name": "ref", "in": "body", "rawType": "string", "rawDescription": "Git ref (typically a branch name) for this codespace", "childParamsGroups": [] }, { "description": "Location for this codespace. Assigned by IP if not provided
", "type": "string", "name": "location", "in": "body", "rawType": "string", "rawDescription": "Location for this codespace. Assigned by IP if not provided", "childParamsGroups": [] }, { "description": "Machine type to use for this codespace
", "type": "string", "name": "machine", "in": "body", "rawType": "string", "rawDescription": "Machine type to use for this codespace", "childParamsGroups": [] }, { "description": "Working directory for this codespace
", "type": "string", "name": "working_directory", "in": "body", "rawType": "string", "rawDescription": "Working directory for this codespace", "childParamsGroups": [] }, { "description": "Time in minutes before codespace stops from inactivity
", "type": "integer", "name": "idle_timeout_minutes", "in": "body", "rawType": "integer", "rawDescription": "Time in minutes before codespace stops from inactivity", "childParamsGroups": [] }, { "description": "Display name for this codespace
", "type": "string", "name": "display_name", "in": "body", "rawType": "string", "rawDescription": "Display name for this codespace", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when the codespace was successfully created
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response when the codespace creation partially failed but is being retried in the background
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } } ], "previews": [], "descriptionHTML": "Creates a codespace owned by the authenticated user in the specified repository.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Response when the codespace was successfully created
" }, { "httpStatusCode": "202", "description": "Response when the codespace creation partially failed but is being retried in the background
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces", "title": "Create a codespace from a pull request", "category": "codespaces", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "description": "Location for this codespace. Assigned by IP if not provided
", "type": "string", "name": "location", "in": "body", "rawType": "string", "rawDescription": "Location for this codespace. Assigned by IP if not provided", "childParamsGroups": [] }, { "description": "Machine type to use for this codespace
", "type": "string", "name": "machine", "in": "body", "rawType": "string", "rawDescription": "Machine type to use for this codespace", "childParamsGroups": [] }, { "description": "Working directory for this codespace
", "type": "string", "name": "working_directory", "in": "body", "rawType": "string", "rawDescription": "Working directory for this codespace", "childParamsGroups": [] }, { "description": "Time in minutes before codespace stops from inactivity
", "type": "integer", "name": "idle_timeout_minutes", "in": "body", "rawType": "integer", "rawDescription": "Time in minutes before codespace stops from inactivity", "childParamsGroups": [] }, { "description": "Display name for this codespace
", "type": "string", "name": "display_name", "in": "body", "rawType": "string", "rawDescription": "Display name for this codespace", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when the codespace was successfully created
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response when the codespace creation partially failed but is being retried in the background
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } } ], "previews": [], "descriptionHTML": "Creates a codespace owned by the authenticated user for the specified pull request.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Response when the codespace was successfully created
" }, { "httpStatusCode": "202", "description": "Response when the codespace creation partially failed but is being retried in the background
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces", "title": "List codespaces for the authenticated user", "category": "codespaces", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "repository_id", "in": "query", "schema": { "type": "integer" }, "descriptionHTML": "ID of the Repository to filter on
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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": [] } ] } } } ], "previews": [], "descriptionHTML": "Lists the authenticated user's codespaces.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/codespaces", "title": "Create a codespace for the authenticated user", "category": "codespaces", "parameters": [], "bodyParameters": [ { "description": "Required. Repository id for this codespace
", "type": "integer", "name": "repository_id", "in": "body", "rawType": "integer", "rawDescription": "Repository id for this codespace", "childParamsGroups": [] }, { "description": "Git ref (typically a branch name) for this codespace
", "type": "string", "name": "ref", "in": "body", "rawType": "string", "rawDescription": "Git ref (typically a branch name) for this codespace", "childParamsGroups": [] }, { "description": "Location for this codespace. Assigned by IP if not provided
", "type": "string", "name": "location", "in": "body", "rawType": "string", "rawDescription": "Location for this codespace. Assigned by IP if not provided", "childParamsGroups": [] }, { "description": "Machine type to use for this codespace
", "type": "string", "name": "machine", "in": "body", "rawType": "string", "rawDescription": "Machine type to use for this codespace", "childParamsGroups": [] }, { "description": "Working directory for this codespace
", "type": "string", "name": "working_directory", "in": "body", "rawType": "string", "rawDescription": "Working directory for this codespace", "childParamsGroups": [] }, { "description": "Time in minutes before codespace stops from inactivity
", "type": "integer", "name": "idle_timeout_minutes", "in": "body", "rawType": "integer", "rawDescription": "Time in minutes before codespace stops from inactivity", "childParamsGroups": [] }, { "description": "Display name for this codespace
", "type": "string", "name": "display_name", "in": "body", "rawType": "string", "rawDescription": "Display name for this codespace", "childParamsGroups": [] }, { "required": [ "pull_request_number", "repository_id" ], "description": "Required. Pull request number for this codespace
", "type": "object", "properties": { "pull_request_number": { "description": "Required. Pull request number
", "type": "integer", "name": "pull_request_number", "in": "body", "rawType": "integer", "rawDescription": "Pull request number", "childParamsGroups": [] }, "repository_id": { "description": "Required. Repository id for this codespace
", "type": "integer", "name": "repository_id", "in": "body", "rawType": "integer", "rawDescription": "Repository id for this codespace", "childParamsGroups": [] } }, "name": "pull_request", "in": "body", "rawType": "object", "rawDescription": "Pull request number for this codespace", "childParamsGroups": [ { "parentName": "pull_request", "parentType": "object", "id": "pull_request-object", "params": [ { "description": "Required. Pull request number
", "type": "integer", "name": "pull_request_number", "in": "body", "rawType": "integer", "rawDescription": "Pull request number", "childParamsGroups": [] }, { "description": "Required. Repository id for this codespace
", "type": "integer", "name": "repository_id", "in": "body", "rawType": "integer", "rawDescription": "Repository id for this codespace", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main", "location": "WestUs2" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response when the codespace was successfully created
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repository_id": 1, "ref": "main", "location": "WestUs2" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response when the codespace creation partially failed but is being retried in the background
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } } ], "previews": [], "descriptionHTML": "Creates a new codespace, owned by the authenticated user.
\nThis endpoint requires either a repository_id OR a pull_request but not both.
You must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Response when the codespace was successfully created
" }, { "httpStatusCode": "202", "description": "Response when the codespace creation partially failed but is being retried in the background
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/{codespace_name}", "title": "Get a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the codespace.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } } ], "previews": [], "descriptionHTML": "Gets information about a user's codespace.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user/codespaces/{codespace_name}", "title": "Update a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the codespace.
" } ], "bodyParameters": [ { "description": "A valid machine to transition this codespace to.
", "type": "string", "name": "machine", "in": "body", "rawType": "string", "rawDescription": "A valid machine to transition this codespace to.", "childParamsGroups": [] }, { "description": "Display name for this codespace
", "type": "string", "name": "display_name", "in": "body", "rawType": "string", "rawDescription": "Display name for this codespace", "childParamsGroups": [] }, { "description": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.
", "type": "array of strings", "items": { "type": "string" }, "name": "recent_folders", "in": "body", "rawType": "array", "rawDescription": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "machine": "standardLinux" }, "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } } ], "previews": [], "descriptionHTML": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.
\nIf you specify a new machine type it will be applied the next time your codespace is started.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/codespaces/{codespace_name}", "title": "Delete a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the codespace.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "202", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "previews": [], "descriptionHTML": "Deletes a user's codespace.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Accepted
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/codespaces/{codespace_name}/exports", "title": "Export a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the codespace.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { "state": "succeeded", "completed_at": "2022-01-01T14:59:22Z", "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", "id": "latest", "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" } } } ], "previews": [], "descriptionHTML": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.
\nYou must authenticate using a personal access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces_lifecycle_admin repository permission to use this endpoint.
Accepted
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/{codespace_name}/exports/{export_id}", "title": "Get details about a codespace export", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the codespace.
" }, { "name": "export_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The ID of the export operation, or latest. Currently only latest is currently supported.
Response
", "example": { "state": "succeeded", "completed_at": "2022-01-01T14:59:22Z", "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", "id": "latest", "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" } } } ], "previews": [], "descriptionHTML": "Gets information about an export of a codespace.
\nYou must authenticate using a personal access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces_lifecycle_admin repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/codespaces/{codespace_name}/start", "title": "Start a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the codespace.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } } ], "previews": [], "descriptionHTML": "Starts a user's codespace.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces_lifecycle_admin repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "402", "description": "Payment required
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/codespaces/{codespace_name}/stop", "title": "Stop a codespace for the authenticated user", "category": "codespaces", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the codespace.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "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", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "recent_folders": [] } } } ], "previews": [], "descriptionHTML": "Stops a user's codespace.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces_lifecycle_admin repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "codespaces" } ], "machines": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/machines", "title": "List available machine types for a repository", "category": "codespaces", "subcategory": "machines", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "location", "in": "query", "schema": { "type": "string", "examples": [ "WestUs2" ] }, "descriptionHTML": "The location to check for available machines. Assigned by IP if not provided.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "machines": [ { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, { "name": "premiumLinux", "display_name": "8 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 8 } ] } } } ], "previews": [], "descriptionHTML": "List the machine types available for a given repository based on its configuration.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces_metadata repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/{codespace_name}/machines", "title": "List machine types for a codespace", "category": "codespaces", "subcategory": "machines", "parameters": [ { "name": "codespace_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the codespace.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "codespace_name": "CODESPACE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "machines": [ { "name": "standardLinux", "display_name": "4 cores, 8 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 8589934592, "cpus": 4 }, { "name": "premiumLinux", "display_name": "8 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 8 } ] } } } ], "previews": [], "descriptionHTML": "List the machine types a codespace can transition to use.
\nYou must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have read access to the codespaces_metadata repository permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] } ], "repository-secrets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/secrets", "title": "List repository secrets", "category": "codespaces", "subcategory": "repository-secrets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "secrets": [ { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "GIST_ID", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the codespaces_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/secrets/public-key", "title": "Get a repository public key", "category": "codespaces", "subcategory": "repository-secrets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the codespaces_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", "title": "Get a repository secret", "category": "codespaces", "subcategory": "repository-secrets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" } } } ], "previews": [], "descriptionHTML": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the codespaces_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}", "title": "Create or update a repository secret", "category": "codespaces", "subcategory": "repository-secrets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key) endpoint.", "childParamsGroups": [] }, { "type": "string", "description": "ID of the key you used to encrypt the secret.
", "name": "key_id", "in": "body", "rawType": "string", "rawDescription": "ID of the key you used to encrypt the secret.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "201", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "201", "description": "Response when creating a secret
" } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the codespaces_secrets repository\npermission to use this endpoint.
Example of encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\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);\nExample of encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample of encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample of encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nsecret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the codespaces_secrets repository permission to use this endpoint.
No Content
" } ] } ], "secrets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/secrets", "title": "List secrets for the authenticated user", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "secrets": [ { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "GIST_ID", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] } } } ], "previews": [], "descriptionHTML": "Lists all secrets available for a user's Codespaces without revealing their\nencrypted values.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/secrets/public-key", "title": "Get public key for the authenticated user", "category": "codespaces", "subcategory": "secrets", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/secrets/{secret_name}", "title": "Get a secret for the authenticated user", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "CODESPACE_GH_SECRET", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories" } } } ], "previews": [], "descriptionHTML": "Gets a secret available to a user's codespaces without revealing its encrypted value.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/codespaces/secrets/{secret_name}", "title": "Create or update a secret for the authenticated user", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.
", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint.", "childParamsGroups": [] }, { "type": "string", "description": "Required. ID of the key you used to encrypt the secret.
", "name": "key_id", "in": "body", "rawType": "string", "rawDescription": "ID of the key you used to encrypt the secret.", "childParamsGroups": [] }, { "type": "array of strings", "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.
", "items": { "type": "string" }, "name": "selected_repository_ids", "in": "body", "rawType": "array", "rawDescription": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "201", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "selected_repository_ids": [ "1234567", "2345678" ] }, "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "201", "description": "Response after successfully creaing a secret
" } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "selected_repository_ids": [ "1234567", "2345678" ] }, "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response after successfully updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response after successfully creaing a secret
" }, { "httpStatusCode": "204", "description": "Response after successfully updating a secret
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "descriptionHTML": "Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must also have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission and codespaces_secrets repository permission on all referenced repositories to use this endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\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);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nsecret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have write access to the codespaces_user_secrets user permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/codespaces/secrets/{secret_name}/repositories", "title": "List selected repositories for a user secret", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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 } ] } } } ], "previews": [], "descriptionHTML": "List the repositories that have been granted the ability to use a user's codespace secret.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have read access to the codespaces_user_secrets user permission and write access to the codespaces_secrets repository permission on all referenced repositories to use this endpoint.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/codespaces/secrets/{secret_name}/repositories", "title": "Set selected repositories for a user secret", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [ { "type": "array of integers", "description": "Required. An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.
", "items": { "type": "integer" }, "name": "selected_repository_ids", "in": "body", "rawType": "array", "rawDescription": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "selected_repository_ids": [ "1296269", "1296280" ] }, "parameters": { "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "No Content when repositories were added to the selected list
" } } ], "previews": [], "descriptionHTML": "Select the repositories that will use a user's codespace secret.
\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have write access to the codespaces_user_secrets user permission and write access to the codespaces_secrets repository permission on all referenced repositories to use this endpoint.
No Content when repositories were added to the selected list
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", "title": "Add a selected repository to a user secret", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "No Content when repository was added to the selected list
" } } ], "previews": [], "descriptionHTML": "Adds a repository to the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the codespaces_user_secrets user permission and write access to the codespaces_secrets repository permission on the referenced repository to use this endpoint.
No Content when repository was added to the selected list
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", "title": "Remove a selected repository from a user secret", "category": "codespaces", "subcategory": "secrets", "parameters": [ { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "No Content when repository was removed from the selected list
" } } ], "previews": [], "descriptionHTML": "Removes a repository from the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the codespaces_user_secrets user permission to use this endpoint.
No Content when repository was removed from the selected list
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] } ] }, "collaborators": { "collaborators": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "affiliation", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "outside", "direct", "all" ], "default": "all" }, "descriptionHTML": "Filter collaborators returned by their affiliation. Can be one of:
\n* outside: All outside collaborators of an organization-owned repository.
\n* direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status.
\n* all: All collaborators the authenticated user can see.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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, "permissions": { "pull": true, "triage": true, "push": true, "maintain": false, "admin": false }, "role_name": "write" } ] } } ], "previews": [], "descriptionHTML": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
\nTeam members will include the members of child teams.
\nYou must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Check if a user is a repository collaborator", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response if user is a collaborator
" } } ], "previews": [], "descriptionHTML": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
\nTeam members will include the members of child teams.
\nYou must authenticate using an access token with the read:org and repo scopes with push access to use this\nendpoint. GitHub Apps must have the members organization permission and metadata repository permission to use this\nendpoint.
Response if user is a collaborator
" }, { "httpStatusCode": "404", "description": "Not Found if user is not a collaborator
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of:
\n* pull - can pull, but not push to or administer this repository.
\n* push - can pull and push, but not administer this repository.
\n* admin - can pull, push and administer this repository.
\n* maintain - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
\n* triage - Recommended for contributors who need to proactively manage issues and pull requests without write access.
\n* custom repository role name - A custom repository role, if the owning organization has defined any.
Response when a new invitation is created
", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "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" }, "invitee": { "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 }, "inviter": { "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 }, "permissions": "write", "created_at": "2016-06-13T14:52:50-05:00", "url": "https://api.github.com/user/repository_invitations/1296269", "html_url": "https://github.com/octocat/Hello-World/invitations" } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when a new invitation is created
" }, { "httpStatusCode": "204", "description": "Response when person is already a collaborator
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", "subcategory": "collaborators", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if user has admin permissions
", "example": { "permission": "admin", "role_name": "admin", "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 } } } } ], "previews": [], "descriptionHTML": "Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
if user has admin permissions
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "invitations": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/invitations", "title": "List repository invitations", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" }, "invitee": { "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 }, "inviter": { "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 }, "permissions": "write", "created_at": "2016-06-13T14:52:50-05:00", "url": "https://api.github.com/user/repository_invitations/1296269", "html_url": "https://github.com/octocat/Hello-World/invitations", "node_id": "MDQ6VXNlcjE=" } ] } } ], "previews": [], "descriptionHTML": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", "title": "Update a repository invitation", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "invitation_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.
Response
", "example": { "id": 1, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "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" }, "invitee": { "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 }, "inviter": { "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 }, "permissions": "write", "created_at": "2016-06-13T14:52:50-05:00", "expired": false, "url": "https://api.github.com/user/repository_invitations/1296269", "html_url": "https://github.com/octocat/Hello-World/invitations" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/invitations/{invitation_id}", "title": "Delete a repository invitation", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "invitation_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/repository_invitations", "title": "List repository invitations for the authenticated user", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" }, "invitee": { "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 }, "inviter": { "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 }, "permissions": "write", "created_at": "2016-06-13T14:52:50-05:00", "url": "https://api.github.com/user/repository_invitations/1296269", "html_url": "https://github.com/octocat/Hello-World/invitations", "node_id": "MDQ6VXNlcjE=" } ] } } ], "previews": [], "descriptionHTML": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user/repository_invitations/{invitation_id}", "title": "Accept a repository invitation", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "invitation_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/repository_invitations/{invitation_id}", "title": "Decline a repository invitation", "category": "collaborators", "subcategory": "invitations", "parameters": [ { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "invitation_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] } ] }, "commits": { "commits": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "sha", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
Only commits containing this file path will be returned.
" }, { "name": "author", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "GitHub login or email address by which to filter by commit author.
" }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "support@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "support@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "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 }, "committer": { "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 }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] } ] } } ], "previews": [], "descriptionHTML": "Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "title": "List branches for HEAD commit", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "commit_sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "commit_sha parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "name": "branch_5", "commit": { "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" }, "protected": false } ] } } ], "previews": [], "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "title": "List pull requests associated with a commit", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "commit_sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "commit_sha parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "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", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "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 }, "body": "Please pull these awesome changes in!", "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 } ], "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" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "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 }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false } ] } } ], "previews": [], "descriptionHTML": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "ref parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "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 }, "committer": { "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 }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ], "stats": { "additions": 104, "deletions": 4, "total": 108 }, "files": [ { "filename": "file1.txt", "additions": 10, "deletions": 2, "changes": 12, "status": "modified", "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", "patch": "@@ -29,7 +29,7 @@\n....." } ] } } } ], "previews": [], "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", "subcategory": "commits", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "basehead", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The base branch and head branch to compare. This parameter expects the format {base}...{head}.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", "permalink_url": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17", "diff_url": "https://github.com/octocat/Hello-World/compare/master...topic.diff", "patch_url": "https://github.com/octocat/Hello-World/compare/master...topic.patch", "base_commit": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "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 }, "committer": { "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 }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] }, "merge_base_commit": { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "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 }, "committer": { "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 }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] }, "status": "behind", "ahead_by": 1, "behind_by": 2, "total_commits": 1, "commits": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "mona@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "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 }, "committer": { "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 }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] } ], "files": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", "filename": "file1.txt", "status": "added", "additions": 103, "deletions": 21, "changes": 124, "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" } ] } } } ], "previews": [], "descriptionHTML": "The basehead param is comprised of two parts: base and head. Both must be branch names in repo. To compare branches across other repositories in the same network as repo, use the format <USERNAME>:branch.
The response from the API is equivalent to running the git log base..head command; however, commits are returned in chronological order. Pass the appropriate media type to fetch diff and patch formats.
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
Working with large comparisons
\nTo process a response with a large number of commits, you can use (per_page or page) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"Traversing with pagination.\"
When calling this API without any paging parameters (per_page or page), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ] } ], "comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments", "title": "List commit comments for a repository", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "title": "Get a commit comment", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "title": "Update a commit comment", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The contents of the comment
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The contents of the comment", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Nice change" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Nice change", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "title": "Delete a commit comment", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "title": "List commit comments", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "commit_sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "commit_sha parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "Use the :commit_sha to specify the commit that will have its comments listed.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "title": "Create a commit comment", "category": "commits", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "commit_sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "commit_sha parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The contents of the comment.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The contents of the comment.", "childParamsGroups": [] }, { "type": "string", "description": "Relative path of the file to comment on.
", "name": "path", "in": "body", "rawType": "string", "rawDescription": "Relative path of the file to comment on.", "childParamsGroups": [] }, { "type": "integer", "description": "Line index in the diff to comment on.
", "name": "position", "in": "body", "rawType": "integer", "rawDescription": "Line index in the diff to comment on.", "childParamsGroups": [] }, { "type": "integer", "description": "Deprecated. Use position parameter instead. Line number in the file to comment on.
", "name": "line", "in": "body", "rawType": "integer", "rawDescription": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 1 }, "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", "id": 1, "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", "body": "Great stuff", "path": "file1.txt", "position": 4, "line": 14, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "author_association": "COLLABORATOR", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z" } } } ], "previews": [], "descriptionHTML": "Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "statuses": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/status", "title": "Get the combined status for a specific reference", "category": "commits", "subcategory": "statuses", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "ref parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "state": "success", "statuses": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "id": 1, "node_id": "MDY6U3RhdHVzMQ==", "state": "success", "description": "Build has completed successfully", "target_url": "https://ci.example.com/1000/output", "context": "continuous-integration/jenkins", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z" }, { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "id": 2, "node_id": "MDY6U3RhdHVzMg==", "state": "success", "description": "Testing has completed successfully", "target_url": "https://ci.example.com/2000/output", "context": "security/brakeman", "created_at": "2012-08-20T01:19:13Z", "updated_at": "2012-08-20T01:19:13Z" } ], "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "total_count": 2, "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" }, "commit_url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e", "url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status" } } } ], "previews": [], "descriptionHTML": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nAdditionally, a combined state is returned. The state is one of:
- \n
- failure if any of the contexts report as
errororfailure\n - pending if there are no statuses or a context is
pending\n - success if the latest status for all contexts is
success\n
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/commits/{ref}/statuses", "title": "List commit statuses for a reference", "category": "commits", "subcategory": "statuses", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "ref parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "id": 1, "node_id": "MDY6U3RhdHVzMQ==", "state": "success", "description": "Build has completed successfully", "target_url": "https://ci.example.com/1000/output", "context": "continuous-integration/jenkins", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "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 } } ] } } ], "previews": [], "descriptionHTML": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.
\nThis resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/statuses/{sha}", "title": "Create a commit status", "category": "commits", "subcategory": "statuses", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The state of the status. Can be one of error, failure, pending, or success.
The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
\nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
\nhttp://ci.example.com/user/repo/build/sha
A short description of the status.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A short description of the status.", "childParamsGroups": [] }, { "type": "string", "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.
", "default": "default", "name": "context", "in": "body", "rawType": "string", "rawDescription": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "success", "target_url": "https://example.com/build/status", "description": "The build succeeded!", "context": "continuous-integration/jenkins" }, "parameters": { "owner": "OWNER", "repo": "REPO", "sha": "SHA" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "id": 1, "node_id": "MDY6U3RhdHVzMQ==", "state": "success", "description": "Build has completed successfully", "target_url": "https://ci.example.com/1000/output", "context": "continuous-integration/jenkins", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "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 } } } } ], "previews": [], "descriptionHTML": "Users with push access in a repository can create commit statuses for a given SHA.
\nNote: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.
Created
" } ] } ] }, "dependabot": { "secrets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/dependabot/secrets", "title": "List organization secrets", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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" } ] } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/dependabot/secrets/public-key", "title": "Get an organization public key", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", "title": "Get an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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" } } } ], "previews": [], "descriptionHTML": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}", "title": "Create or update an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the 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})$", "name": "encrypted_value", "in": "body", "rawType": "string", "rawDescription": "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.", "childParamsGroups": [] }, { "type": "string", "description": "ID of the key you used to encrypt the secret.
", "name": "key_id", "in": "body", "rawType": "string", "rawDescription": "ID of the key you used to encrypt the secret.", "childParamsGroups": [] }, { "type": "string", "description": "Required. Configures the access that repositories have to the organization secret. Can be one of:
\n- all - All repositories in an organization can access the secret.
\n- private - Private repositories in an organization can access the secret.
\n- selected - Only specific repositories can access the secret.
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, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Response when creating a secret
" } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ "1296269", "1296280" ] }, "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\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);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nsecret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", "title": "List selected repositories for an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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" } ] } } } ], "previews": [], "descriptionHTML": "Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories", "title": "Set selected repositories for an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [ { "type": "array of integers", "description": "Required. 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 and Remove selected repository from an organization secret endpoints.
Response
" } } ], "previews": [], "descriptionHTML": "Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", "title": "Add selected repository to an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "No Content when repository was added to the selected list
" } } ], "previews": [], "descriptionHTML": "Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
No Content when repository was added to the selected list
" }, { "httpStatusCode": "409", "description": "Conflict when visibility type is not set to selected
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", "title": "Remove selected repository from an organization secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" }, { "name": "repository_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "secret_name": "SECRET_NAME", "repository_id": "REPOSITORY_ID" } }, "response": { "statusCode": "204", "description": "Response when repository was removed from the selected list
" } } ], "previews": [], "descriptionHTML": "Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization permission to use this endpoint.
Response when repository was removed from the selected list
" }, { "httpStatusCode": "409", "description": "Conflict when visibility type not set to selected
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/dependabot/secrets", "title": "List repository secrets", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "secrets": [ { "name": "AZURE_DEVOPS_PAT", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "MY_ARTIFACTORY_PASSWORD", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] } } } ], "previews": [], "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/public-key", "title": "Get a repository public key", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } ], "previews": [], "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "title": "Get a repository secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "MY_ARTIFACTORY_PASSWORD", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" } } } ], "previews": [], "descriptionHTML": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "title": "Create or update a repository secret", "category": "dependabot", "subcategory": "secrets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "secret_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "secret_name parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint.", "childParamsGroups": [] }, { "type": "string", "description": "ID of the key you used to encrypt the secret.
", "name": "key_id", "in": "body", "rawType": "string", "rawDescription": "ID of the key you used to encrypt the secret.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "201", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "201", "description": "Response when creating a secret
" } }, { "key": "204", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" }, "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response when updating a secret
" } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Response when creating a secret
" }, { "httpStatusCode": "204", "description": "Response when updating a secret
" } ], "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository\npermission to use this endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the tweetsodium library.
\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);\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nsecret_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "secret_name": "SECRET_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the dependabot_secrets repository permission to use this endpoint.
No Content
" } ] } ] }, "dependency-graph": { "dependency-review": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}", "title": "Get a diff of the dependencies between commits", "category": "dependency-graph", "subcategory": "dependency-review", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "basehead", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format {base}...{head}.
The full path, relative to the repository root, of the dependency manifest file.
" } ], "bodyParameters": [], "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "basehead": "BASEHEAD" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "change_type": "removed", "manifest": "package.json", "ecosystem": "npm", "name": "helmet", "version": "4.6.0", "package_url": "pkg:npm/helmet@4.6.0", "license": "MIT", "source_repository_url": "https://github.com/helmetjs/helmet", "vulnerabilities": [] }, { "change_type": "added", "manifest": "package.json", "ecosystem": "npm", "name": "helmet", "version": "5.0.0", "package_url": "pkg:npm/helmet@5.0.0", "license": "MIT", "source_repository_url": "https://github.com/helmetjs/helmet", "vulnerabilities": [] }, { "change_type": "added", "manifest": "Gemfile", "ecosystem": "rubygems", "name": "ruby-openid", "version": "2.7.0", "package_url": "pkg:gem/ruby-openid@2.7.0", "license": null, "source_repository_url": "https://github.com/openid/ruby-openid", "vulnerabilities": [ { "severity": "critical", "advisory_ghsa_id": "GHSA-fqfj-cmh6-hj49", "advisory_summary": "Ruby OpenID", "advisory_url": "https://github.com/advisories/GHSA-fqfj-cmh6-hj49" } ] } ] } } ], "previews": [], "descriptionHTML": "Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "deploy-keys": { "deploy-keys": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", "title": "List deploy keys", "category": "deploy-keys", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "key": "ssh-rsa AAA...", "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", "title": "octocat@octomac", "verified": true, "created_at": "2014-12-10T15:53:42Z", "read_only": true } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", "title": "Create a deploy key", "category": "deploy-keys", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "A name for the key.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "A name for the key.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The contents of the key.
", "name": "key", "in": "body", "rawType": "string", "rawDescription": "The contents of the key.", "childParamsGroups": [] }, { "type": "boolean", "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
", "name": "read_only", "in": "body", "rawType": "boolean", "rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "octocat@octomac", "key": "ssh-rsa AAA...", "read_only": true }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "key": "ssh-rsa AAA...", "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", "title": "octocat@octomac", "verified": true, "created_at": "2014-12-10T15:53:42Z", "read_only": true } } } ], "previews": [], "descriptionHTML": "You can create a read-only deploy key.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Get a deploy key", "category": "deploy-keys", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "key_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "key_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "key_id": "KEY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "key": "ssh-rsa AAA...", "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", "title": "octocat@octomac", "verified": true, "created_at": "2014-12-10T15:53:42Z", "read_only": true } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Delete a deploy key", "category": "deploy-keys", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "key_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "key_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "key_id": "KEY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "deploy-keys" } ] }, "deployments": { "deployments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", "subcategory": "deployments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "sha", "in": "query", "required": false, "schema": { "type": "string", "default": "none" }, "descriptionHTML": "The SHA recorded at creation time.
" }, { "name": "ref", "in": "query", "required": false, "schema": { "type": "string", "default": "none" }, "descriptionHTML": "The name of the ref. This can be a branch, tag, or SHA.
" }, { "name": "task", "in": "query", "required": false, "schema": { "type": "string", "default": "none" }, "descriptionHTML": "The name of the task for the deployment (e.g., deploy or deploy:migrations).
The name of the environment that was deployed to (e.g., staging or production).
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, "node_id": "MDEwOkRlcGxveW1lbnQx", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "ref": "topic-branch", "task": "deploy", "payload": {}, "original_environment": "staging", "environment": "production", "description": "Deploy request from hubot", "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 }, "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "repository_url": "https://api.github.com/repos/octocat/example", "transient_environment": false, "production_environment": true } ] } } ], "previews": [], "descriptionHTML": "Simple filtering of deployments is available via query parameters:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", "subcategory": "deployments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The ref to deploy. This can be a branch, tag, or SHA.
", "name": "ref", "in": "body", "rawType": "string", "rawDescription": "The ref to deploy. This can be a branch, tag, or SHA.", "childParamsGroups": [] }, { "type": "string", "description": "Specifies a task to execute (e.g., deploy or deploy:migrations).
Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
", "default": true, "name": "auto_merge", "in": "body", "rawType": "boolean", "rawDescription": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", "childParamsGroups": [] }, { "type": "array of strings", "description": "The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.
", "items": { "type": "string" }, "name": "required_contexts", "in": "body", "rawType": "array", "rawDescription": "The [status](https://docs.github.com/rest/reference/commits#commit-statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "childParamsGroups": [] }, { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "description": "JSON payload with extra information about the deployment.", "default": "" } ], "name": "payload", "in": "body", "type": "object or string or ", "description": "JSON payload with extra information about the deployment.
", "childParamsGroups": [] }, { "type": "string", "description": "Name for the target deployment environment (e.g., production, staging, qa).
Short description of the deployment.
", "default": "", "name": "description", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "Short description of the deployment.", "childParamsGroups": [] }, { "type": "boolean", "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false
Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.
Simple example
", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, "node_id": "MDEwOkRlcGxveW1lbnQx", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "ref": "topic-branch", "task": "deploy", "payload": {}, "original_environment": "staging", "environment": "production", "description": "Deploy request from hubot", "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 }, "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "repository_url": "https://api.github.com/repos/octocat/example", "transient_environment": false, "production_environment": true } } } ], "previews": [], "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.
The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.
The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.
By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.
The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.
The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
Merged branch response
\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:
\n- \n
- Auto-merge option is enabled in the repository \n
- Topic branch does not include the latest changes on the base branch, which is
masterin the response example \n - There are no merge conflicts \n
If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nMerge conflict response
\nThis error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.
Failed commit status checks
\nThis error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.
Created
" }, { "httpStatusCode": "202", "description": "Merged branch response
" }, { "httpStatusCode": "409", "description": "Conflict when there is a merge conflict or the commit's status checks failed
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", "subcategory": "deployments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "deployment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "deployment_id": "DEPLOYMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/1", "id": 1, "node_id": "MDEwOkRlcGxveW1lbnQx", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "ref": "topic-branch", "task": "deploy", "payload": {}, "original_environment": "staging", "environment": "production", "description": "Deploy request from hubot", "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 }, "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", "repository_url": "https://api.github.com/repos/octocat/example", "transient_environment": false, "production_environment": true } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", "subcategory": "deployments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "deployment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "deployment_id": "DEPLOYMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with repo or repo_deployment scopes can delete a deployment.
To set a deployment as inactive, you must:
\n- \n
- Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. \n
- Mark the active deployment as inactive by adding any non-successful deployment status. \n
For more information, see \"Create a deployment\" and \"Create a deployment status.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "environments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/environments", "title": "Get all environments", "category": "deployments", "subcategory": "environments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "environments": [ { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", "name": "staging", "url": "https://api.github.com/repos/github/hello-world/environments/staging", "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", "created_at": "2020-11-23T22:00:40Z", "updated_at": "2020-11-23T22:00:40Z", "protection_rules": [ { "id": 3736, "node_id": "MDQ6R2F0ZTM3MzY=", "type": "wait_timer", "wait_timer": 30 }, { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", "type": "required_reviewers", "reviewers": [ { "type": "User", "reviewer": { "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": "Team", "reviewer": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } } ] }, { "id": 3756, "node_id": "MDQ6R2F0ZTM3NTY=", "type": "branch_policy" } ], "deployment_branch_policy": { "protected_branches": false, "custom_branch_policies": true } } ] } } } ], "previews": [], "descriptionHTML": "Get all environments for a repository.
\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", "title": "Get an environment", "category": "deployments", "subcategory": "environments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "environment_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the environment
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", "name": "staging", "url": "https://api.github.com/repos/github/hello-world/environments/staging", "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", "created_at": "2020-11-23T22:00:40Z", "updated_at": "2020-11-23T22:00:40Z", "protection_rules": [ { "id": 3736, "node_id": "MDQ6R2F0ZTM3MzY=", "type": "wait_timer", "wait_timer": 30 }, { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", "type": "required_reviewers", "reviewers": [ { "type": "User", "reviewer": { "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": "Team", "reviewer": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } } ] }, { "id": 3756, "node_id": "MDQ6R2F0ZTM3NTY=", "type": "branch_policy" } ], "deployment_branch_policy": { "protected_branches": false, "custom_branch_policies": true } } } } ], "previews": [], "descriptionHTML": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", "title": "Create or update an environment", "category": "deployments", "subcategory": "environments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "environment_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The name of the environment
" } ], "bodyParameters": [ { "type": "integer", "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
", "examples": [ 30 ], "name": "wait_timer", "in": "body", "rawType": "integer", "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", "childParamsGroups": [] }, { "type": "array of objects or null", "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of reviewer. Must be one of: User or Team
The id of the user or team who can review the deployment
", "examples": [ 4532992 ], "name": "id", "in": "body", "rawType": "integer", "rawDescription": "The id of the user or team who can review the deployment", "childParamsGroups": [] } } }, "name": "reviewers", "in": "body", "rawType": [ "array", "null" ], "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "childParamsGroups": [ { "parentName": "reviewers", "parentType": "items", "id": "reviewers-items", "params": [ { "type": "string", "description": "The type of reviewer. Must be one of: User or Team
The id of the user or team who can review the deployment
", "examples": [ 4532992 ], "name": "id", "in": "body", "rawType": "integer", "rawDescription": "The id of the user or team who can review the deployment", "childParamsGroups": [] } ] } ] }, { "type": "object or null", "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.
Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.
Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.
Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.
Response
", "example": { "id": 161088068, "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", "name": "staging", "url": "https://api.github.com/repos/github/hello-world/environments/staging", "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", "created_at": "2020-11-23T22:00:40Z", "updated_at": "2020-11-23T22:00:40Z", "protection_rules": [ { "id": 3736, "node_id": "MDQ6R2F0ZTM3MzY=", "type": "wait_timer", "wait_timer": 30 }, { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", "type": "required_reviewers", "reviewers": [ { "type": "User", "reviewer": { "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": "Team", "reviewer": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } } ] }, { "id": 3756, "node_id": "MDQ6R2F0ZTM3NTY=", "type": "branch_policy" } ], "deployment_branch_policy": { "protected_branches": false, "custom_branch_policies": true } } } } ], "previews": [], "descriptionHTML": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"
\nNote: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"Environments.\"
\nNote: To create or update secrets for an environment, see \"Secrets.\"
\nYou must authenticate using an access token with the repo scope to use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation error when the environment name is invalid or when protected_branches and custom_branch_policies in deployment_branch_policy are set to the same value
The name of the environment
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "environment_name": "ENVIRONMENT_NAME" } }, "response": { "statusCode": "204", "description": "Default response
" } } ], "previews": [], "descriptionHTML": "You must authenticate using an access token with the repo scope to use this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", "description": "Default response
" } ] } ], "statuses": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "title": "List deployment statuses", "category": "deployments", "subcategory": "statuses", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "deployment_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "deployment_id": "DEPLOYMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", "state": "success", "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 }, "description": "Deployment finished successfully.", "environment": "production", "target_url": "https://example.com/deployment/42/output", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", "repository_url": "https://api.github.com/repos/octocat/example", "environment_url": "https://test-branch.lab.acme.com", "log_url": "https://example.com/deployment/42/output" } ] } } ], "previews": [], "descriptionHTML": "Users with pull access can view deployment statuses for a deployment:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "title": "Create a deployment status", "category": "deployments", "subcategory": "statuses", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "deployment_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The state of the status. Can be one of error, failure, inactive, in_progress, queued, pending, or success. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.
The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.
The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"
A short description of the status. The maximum description length is 140 characters.
", "default": "", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A short description of the status. The maximum description length is 140 characters.", "childParamsGroups": [] }, { "type": "string", "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.
Sets the URL for accessing your environment. Default: \"\"
Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true
Response
", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", "state": "success", "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 }, "description": "Deployment finished successfully.", "environment": "production", "target_url": "https://example.com/deployment/42/output", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", "repository_url": "https://api.github.com/repos/octocat/example", "environment_url": "https://test-branch.lab.acme.com", "log_url": "https://example.com/deployment/42/output" } } } ], "previews": [], "descriptionHTML": "Users with push access can create deployment statuses for a given deployment.
GitHub Apps require read & write access to \"Deployments\" and read-only access to \"Repo contents\" (for private repos). OAuth Apps require the repo_deployment scope.
Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", "title": "Get a deployment status", "category": "deployments", "subcategory": "statuses", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "deployment_id parameter
" }, { "name": "status_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "deployment_id": "DEPLOYMENT_ID", "status_id": "STATUS_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", "id": 1, "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", "state": "success", "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 }, "description": "Deployment finished successfully.", "environment": "production", "target_url": "https://example.com/deployment/42/output", "created_at": "2012-07-20T01:19:13Z", "updated_at": "2012-07-20T01:19:13Z", "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", "repository_url": "https://api.github.com/repos/octocat/example", "environment_url": "https://test-branch.lab.acme.com", "log_url": "https://example.com/deployment/42/output" } } } ], "previews": [], "descriptionHTML": "Users with pull access can view a deployment status for a deployment:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "emojis": { "emojis": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/emojis", "title": "Get emojis", "category": "emojis", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "200", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Lists all the emojis available to use on GitHub.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "emojis" } ] }, "enterprise-admin": { "audit-log": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/audit-log", "title": "Get the audit log for an enterprise", "category": "enterprise-admin", "subcategory": "audit-log", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "phrase", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A search phrase. For more information, see Searching the audit log.
" }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "web", "git", "all" ] }, "descriptionHTML": "The event types to include:
\n- \n
web- returns web (non-Git) events. \ngit- returns Git events. \nall- returns both web and Git events. \n
The default is web.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
" }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
" }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] }, "descriptionHTML": "The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
The default is desc.
Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "@timestamp": 1606929874512, "action": "team.add_member", "actor": "octocat", "created_at": 1606929874512, "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", "org": "octo-corp", "team": "octo-corp/example-team", "user": "monalisa" }, { "@timestamp": 1606507117008, "action": "org.create", "actor": "octocat", "created_at": 1606507117008, "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", "org": "octocat-test-org" }, { "@timestamp": 1605719148837, "action": "repo.destroy", "actor": "monalisa", "created_at": 1605719148837, "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", "org": "mona-org", "repo": "mona-org/mona-test-repo", "visibility": "private" } ] } } ], "previews": [], "descriptionHTML": "Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise scope.
OK
" } ] } ], "billing": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/actions", "title": "Get GitHub Actions billing for an enterprise", "category": "enterprise-admin", "subcategory": "billing", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } } } } ], "previews": [], "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nThe authenticated user must be an enterprise admin.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security", "title": "Get GitHub Advanced Security active committers for an enterprise", "category": "enterprise-admin", "subcategory": "billing", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Success
", "example": { "total_advanced_security_committers": 2, "repositories": [ { "name": "octocat-org/Hello-World", "advanced_security_committers": 2, "advanced_security_committers_breakdown": [ { "user_login": "octocat", "last_pushed_date": "2021-11-03" }, { "user_login": "octokitten", "last_pushed_date": "2021-10-25" } ] }, { "name": "octocat-org/server", "advanced_security_committers": 1, "advanced_security_committers_breakdown": [ { "user_login": "octokitten", "last_pushed_date": "2021-10-26" } ] } ] } } } ], "previews": [], "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Success
" }, { "httpStatusCode": "403", "description": "Response if GitHub Advanced Security is not enabled for this repository
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/packages", "title": "Get GitHub Packages billing for an enterprise", "category": "enterprise-admin", "subcategory": "billing", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 } } } ], "previews": [], "descriptionHTML": "Gets the free and paid storage used for GitHub Packages in gigabytes.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/settings/billing/shared-storage", "title": "Get shared storage billing for an enterprise", "category": "enterprise-admin", "subcategory": "billing", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 } } } ], "previews": [], "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nThe authenticated user must be an enterprise admin.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "scim": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", "title": "List provisioned SCIM groups for an enterprise", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "Used for pagination: the index of the first result to return.
" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "Used for pagination: the number of results to return.
" }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "filter results
" }, { "name": "excludedAttributes", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "attributes to exclude
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 2, "itemsPerPage": 2, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "display": "hubot@example.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:00", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } }, { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "5e75bbbb-aa1a-11ea-8644-75ff655cdddd", "externalId": null, "displayName": "octo-docs-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T16:28:01.000+10:00", "lastModified": "2020-06-09T16:28:01.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd" } } ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups", "title": "Provision a SCIM enterprise group and invite users", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. The SCIM schema URIs.
", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "rawDescription": "The SCIM schema URIs.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The name of the SCIM group. This must match the GitHub organization that the group maps to.
", "name": "displayName", "in": "body", "rawType": "string", "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", "childParamsGroups": [] }, { "type": "array of objects", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Required. The SCIM user ID for a user.
", "name": "value", "in": "body", "rawType": "string", "rawDescription": "The SCIM user ID for a user.", "childParamsGroups": [] } }, "required": [ "value" ] }, "name": "members", "in": "body", "rawType": "array", "description": "", "childParamsGroups": [ { "parentName": "members", "parentType": "items", "id": "members-items", "params": [ { "type": "string", "description": "Required. The SCIM user ID for a user.
", "name": "value", "in": "body", "rawType": "string", "rawDescription": "The SCIM user ID for a user.", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } ] }, "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "display": "hubot@example.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:0", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "title": "Get SCIM provisioning information for an enterprise group", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "scim_group_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "Identifier generated by the GitHub SCIM endpoint.
" }, { "name": "excludedAttributes", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "Attributes to exclude.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "display": "hubot@example.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:0", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "title": "Set SCIM information for a provisioned enterprise group", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "scim_group_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "Identifier generated by the GitHub SCIM endpoint.
" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. The SCIM schema URIs.
", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "rawDescription": "The SCIM schema URIs.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The name of the SCIM group. This must match the GitHub organization that the group maps to.
", "name": "displayName", "in": "body", "rawType": "string", "rawDescription": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", "childParamsGroups": [] }, { "type": "array of objects", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Required. The SCIM user ID for a user.
", "name": "value", "in": "body", "rawType": "string", "rawDescription": "The SCIM user ID for a user.", "childParamsGroups": [] } }, "required": [ "value" ] }, "name": "members", "in": "body", "rawType": "array", "description": "", "childParamsGroups": [ { "parentName": "members", "parentType": "items", "id": "members-items", "params": [ { "type": "string", "description": "Required. The SCIM user ID for a user.
", "name": "value", "in": "body", "rawType": "string", "rawDescription": "The SCIM user ID for a user.", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } ] }, "parameters": { "enterprise": "ENTERPRISE", "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", "display": "hubot@example.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:0", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "title": "Update an attribute for a SCIM enterprise group", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "scim_group_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "Identifier generated by the GitHub SCIM endpoint.
" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. The SCIM schema URIs.
", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "rawDescription": "The SCIM schema URIs.", "childParamsGroups": [] }, { "type": "array of objects", "description": "Required. Array of SCIM operations.
", "minItems": 1, "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "Add", "remove", "Remove", "replace", "Replace" ], "name": "op", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, "path": { "type": "string", "name": "path", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, "value": { "description": "Can be any value - string, number, array or object.
", "name": "value", "in": "body", "type": "", "rawDescription": "Can be any value - string, number, array or object.", "childParamsGroups": [] } }, "required": [ "op" ] }, "name": "Operations", "in": "body", "rawType": "array", "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", "childParamsGroups": [ { "parentName": "Operations", "parentType": "items", "id": "operations-items", "params": [ { "type": "string", "enum": [ "add", "Add", "remove", "Remove", "replace", "Replace" ], "name": "op", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, { "type": "string", "name": "path", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, { "description": "Can be any value - string, number, array or object.
", "name": "value", "in": "body", "type": "", "rawDescription": "Can be any value - string, number, array or object.", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "remove", "path": "members", "value": [ { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } ] } ] }, "parameters": { "enterprise": "ENTERPRISE", "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", "externalId": null, "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "display": "octocat@github.com" } ], "meta": { "resourceType": "Group", "created": "2020-06-09T03:10:17.000+10:00", "lastModified": "2020-06-09T03:10:17.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" } } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "title": "Delete a SCIM group from an enterprise", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "scim_group_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "Identifier generated by the GitHub SCIM endpoint.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "scim_group_id": "SCIM_GROUP_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/enterprises/{enterprise}/Users", "title": "List SCIM provisioned identities for an enterprise", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "Used for pagination: the index of the first result to return.
" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "Used for pagination: the number of results to return.
" }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "filter results
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 2, "itemsPerPage": 2, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "octocat@github.com", "name": { "givenName": "Mona", "familyName": "Octocat" }, "emails": [ { "value": "octocat@github.com", "primary": true, "type": "work" } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2020-05-30T04:02:34.000+10:00", "lastModified": "2020-05-30T04:05:04.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } }, { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5", "externalId": "sdfoiausdofiua", "userName": "hubot@example.com", "name": { "givenName": "hu", "familyName": "bot" }, "emails": [ { "value": "hubot@example.com", "type": "work", "primary": true } ], "groups": [], "active": true, "meta": { "resourceType": "User", "created": "2020-06-05T08:29:40.000+10:00", "lastModified": "2020-06-05T08:30:19.000+10:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5" } } ] } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nRetrieves a paginated list of all provisioned enterprise members, including pending invitations.
\nWhen a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:
\n- \n
- When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future. \n
- When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). \n
- When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. \n
The returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:
- \n
- \n
The user is granted access by the IdP and is not a member of the GitHub enterprise.
\n \n - \n
The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.
\n \n - \n
After successfully authenticating with the SAML SSO IdP, the
\nnullexternal identity entry is created and the user is prompted to sign in to their GitHub account:- \n
- If the user signs in, their GitHub account is linked to this entry. \n
- If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity
nullentry remains in place. \n
\n
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/scim/v2/enterprises/{enterprise}/Users", "title": "Provision and invite a SCIM enterprise user", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. The SCIM schema URIs.
", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "rawDescription": "The SCIM schema URIs.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The username for the user.
", "name": "userName", "in": "body", "rawType": "string", "rawDescription": "The username for the user.", "childParamsGroups": [] }, { "type": "object", "properties": { "givenName": { "type": "string", "description": "Required. The first name of the user.
", "name": "givenName", "in": "body", "rawType": "string", "rawDescription": "The first name of the user.", "childParamsGroups": [] }, "familyName": { "type": "string", "description": "Required. The last name of the user.
", "name": "familyName", "in": "body", "rawType": "string", "rawDescription": "The last name of the user.", "childParamsGroups": [] } }, "required": [ "givenName", "familyName" ], "name": "name", "in": "body", "rawType": "object", "description": "Required.
", "childParamsGroups": [ { "parentName": "name", "parentType": "object", "id": "name-object", "params": [ { "type": "string", "description": "Required. The first name of the user.
", "name": "givenName", "in": "body", "rawType": "string", "rawDescription": "The first name of the user.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The last name of the user.
", "name": "familyName", "in": "body", "rawType": "string", "rawDescription": "The last name of the user.", "childParamsGroups": [] } ] } ] }, { "type": "array of objects", "description": "Required. List of user emails.
", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Required. The email address.
", "name": "value", "in": "body", "rawType": "string", "rawDescription": "The email address.", "childParamsGroups": [] }, "type": { "type": "string", "description": "Required. The type of email address.
", "name": "type", "in": "body", "rawType": "string", "rawDescription": "The type of email address.", "childParamsGroups": [] }, "primary": { "type": "boolean", "description": "Required. Whether this email address is the primary address.
", "name": "primary", "in": "body", "rawType": "boolean", "rawDescription": "Whether this email address is the primary address.", "childParamsGroups": [] } }, "required": [ "value", "type", "primary" ] }, "name": "emails", "in": "body", "rawType": "array", "rawDescription": "List of user emails.", "childParamsGroups": [ { "parentName": "emails", "parentType": "items", "id": "emails-items", "params": [ { "type": "string", "description": "Required. The email address.
", "name": "value", "in": "body", "rawType": "string", "rawDescription": "The email address.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The type of email address.
", "name": "type", "in": "body", "rawType": "string", "rawDescription": "The type of email address.", "childParamsGroups": [] }, { "type": "boolean", "description": "Required. Whether this email address is the primary address.
", "name": "primary", "in": "body", "rawType": "boolean", "rawDescription": "Whether this email address is the primary address.", "childParamsGroups": [] } ] } ] }, { "type": "array of objects", "description": "List of SCIM group IDs the user is a member of.
", "items": { "type": "object", "properties": { "value": { "type": "string", "name": "value", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } } }, "name": "groups", "in": "body", "rawType": "array", "rawDescription": "List of SCIM group IDs the user is a member of.", "childParamsGroups": [ { "parentName": "groups", "parentType": "items", "id": "groups-items", "params": [ { "type": "string", "name": "value", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName": "mona.octocat@okta.example.com", "name": { "familyName": "Octocat", "givenName": "Mona" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ] }, "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "mona.octocat@okta.example.com", "name": { "givenName": "Mona", "familyName": "Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nProvision enterprise membership for a user, and send organization invitation emails to the email address.
\nYou can optionally include the groups a user will be invited to join. If you do not provide a list of groups, the user is provisioned for the enterprise, but no organization invitation emails will be sent.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "title": "Get SCIM provisioning information for an enterprise user", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "scim_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "scim_user_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "mona.octocat@okta.example.com", "name": { "givenName": "Mona", "familyName": "Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "title": "Set SCIM information for a provisioned enterprise user", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "scim_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "scim_user_id parameter
" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. The SCIM schema URIs.
", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "rawDescription": "The SCIM schema URIs.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The username for the user.
", "name": "userName", "in": "body", "rawType": "string", "rawDescription": "The username for the user.", "childParamsGroups": [] }, { "type": "object", "properties": { "givenName": { "type": "string", "description": "Required. The first name of the user.
", "name": "givenName", "in": "body", "rawType": "string", "rawDescription": "The first name of the user.", "childParamsGroups": [] }, "familyName": { "type": "string", "description": "Required. The last name of the user.
", "name": "familyName", "in": "body", "rawType": "string", "rawDescription": "The last name of the user.", "childParamsGroups": [] } }, "required": [ "givenName", "familyName" ], "name": "name", "in": "body", "rawType": "object", "description": "Required.
", "childParamsGroups": [ { "parentName": "name", "parentType": "object", "id": "name-object", "params": [ { "type": "string", "description": "Required. The first name of the user.
", "name": "givenName", "in": "body", "rawType": "string", "rawDescription": "The first name of the user.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The last name of the user.
", "name": "familyName", "in": "body", "rawType": "string", "rawDescription": "The last name of the user.", "childParamsGroups": [] } ] } ] }, { "type": "array of objects", "description": "Required. List of user emails.
", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "Required. The email address.
", "name": "value", "in": "body", "rawType": "string", "rawDescription": "The email address.", "childParamsGroups": [] }, "type": { "type": "string", "description": "Required. The type of email address.
", "name": "type", "in": "body", "rawType": "string", "rawDescription": "The type of email address.", "childParamsGroups": [] }, "primary": { "type": "boolean", "description": "Required. Whether this email address is the primary address.
", "name": "primary", "in": "body", "rawType": "boolean", "rawDescription": "Whether this email address is the primary address.", "childParamsGroups": [] } }, "required": [ "value", "type", "primary" ] }, "name": "emails", "in": "body", "rawType": "array", "rawDescription": "List of user emails.", "childParamsGroups": [ { "parentName": "emails", "parentType": "items", "id": "emails-items", "params": [ { "type": "string", "description": "Required. The email address.
", "name": "value", "in": "body", "rawType": "string", "rawDescription": "The email address.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The type of email address.
", "name": "type", "in": "body", "rawType": "string", "rawDescription": "The type of email address.", "childParamsGroups": [] }, { "type": "boolean", "description": "Required. Whether this email address is the primary address.
", "name": "primary", "in": "body", "rawType": "boolean", "rawDescription": "Whether this email address is the primary address.", "childParamsGroups": [] } ] } ] }, { "type": "array of objects", "description": "List of SCIM group IDs the user is a member of.
", "items": { "type": "object", "properties": { "value": { "type": "string", "name": "value", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } } }, "name": "groups", "in": "body", "rawType": "array", "rawDescription": "List of SCIM group IDs the user is a member of.", "childParamsGroups": [ { "parentName": "groups", "parentType": "items", "id": "groups-items", "params": [ { "type": "string", "name": "value", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName": "mona.octocat@okta.example.com", "name": { "familyName": "Octocat", "givenName": "Mona" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ] }, "parameters": { "enterprise": "ENTERPRISE", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "mona.octocat@okta.example.com", "name": { "givenName": "Mona", "familyName": "Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } } } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nReplaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nYou must at least provide the required values for the user: userName, name, and emails.
Warning: Setting active: false removes the user from the enterprise, deletes the external identity, and deletes the associated {scim_user_id}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "title": "Update an attribute for a SCIM enterprise user", "category": "enterprise-admin", "subcategory": "scim", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "scim_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "scim_user_id parameter
" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. The SCIM schema URIs.
", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "rawDescription": "The SCIM schema URIs.", "childParamsGroups": [] }, { "type": "array of objects", "description": "Required. Array of SCIM operations.
", "items": { "type": "object" }, "name": "Operations", "in": "body", "rawType": "array", "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "emails", "value": [ { "value": "monalisa@octocat.github.com", "type": "home" } ] }, { "op": "replace", "path": "name.givenName", "value": "Monalisa" } ] }, "parameters": { "enterprise": "ENTERPRISE", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", "externalId": "00dowz5dr9oSfDFRA0h7", "userName": "mona.octocat@okta.example.com", "name": { "givenName": "Monalisa", "familyName": "Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "type": "work", "primary": true }, { "value": "monalisa@octocat.github.com", "type": "home" } ], "groups": [ { "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" } } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
\nAllows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated :scim_user_id.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nThe slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "scim_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "scim_user_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ] }, "gists": { "gists": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists", "title": "List gists for the authenticated user", "category": "gists", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/gists", "title": "Create a gist", "category": "gists", "parameters": [], "bodyParameters": [ { "description": "Description of the gist
", "type": "string", "examples": [ "Example Ruby script" ], "name": "description", "in": "body", "rawType": "string", "rawDescription": "Description of the gist", "childParamsGroups": [] }, { "description": "Required. Names and content for the files that make up the gist
", "type": "object", "additionalProperties": { "type": "object", "properties": { "content": { "description": "Content of the file", "readOnly": false, "type": "string" } }, "required": [ "content" ] }, "examples": [ { "hello.rb": { "content": "puts \"Hello, World!\"" } } ], "name": "files", "in": "body", "rawType": "object", "rawDescription": "Names and content for the files that make up the gist", "childParamsGroups": [] }, { "oneOf": [ { "description": "Flag indicating whether the gist is public", "type": "boolean", "default": false, "examples": [ true ] }, { "type": "string", "default": "false", "enum": [ "true", "false" ], "examples": [ "true" ] } ], "name": "public", "in": "body", "type": "boolean or string or ", "description": "Flag indicating whether the gist is public
", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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", "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" } } } ], "previews": [], "descriptionHTML": "Allows you to add a new gist with one or more files.
\nNote: Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/public", "title": "List public gists", "category": "gists", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "List public gists sorted by most recently updated to least recently updated.
\nNote: With pagination, 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.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/starred", "title": "List starred gists", "category": "gists", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "List the authenticated user's starred gists:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}", "title": "Get a gist", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden Gist
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/gists/{gist_id}", "title": "Update a gist", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" } ], "bodyParameters": [ { "description": "Description of the gist
", "type": "string", "examples": [ "Example Ruby script" ], "name": "description", "in": "body", "rawType": "string", "rawDescription": "Description of the gist", "childParamsGroups": [] }, { "description": "Names of files to be updated
", "type": "object", "additionalProperties": { "type": [ "object", "null" ], "properties": { "content": { "description": "The new content of the file", "type": "string" }, "filename": { "description": "The new filename for the file", "type": [ "string", "null" ] } }, "anyOf": [ { "required": [ "content" ] }, { "required": [ "filename" ] }, { "type": "object", "maxProperties": 0 } ] }, "examples": [ { "hello.rb": { "content": "blah", "filename": "goodbye.rb" } } ], "name": "files", "in": "body", "rawType": "object", "rawDescription": "Names of files to be updated", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" } } } ], "previews": [], "descriptionHTML": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/gists/{gist_id}", "title": "Delete a gist", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/commits", "title": "List gist commits", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/forks", "title": "List gist forks", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/gists/{gist_id}/forks", "title": "Fork a gist", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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 } } } ], "previews": [], "descriptionHTML": "Note: This was previously /gists/:gist_id/fork.
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/star", "title": "Check if a gist is starred", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "204", "description": "Response if gist is starred
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "Response if gist is starred
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found if gist is not starred
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/gists/{gist_id}/star", "title": "Star a gist", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/gists/{gist_id}/star", "title": "Unstar a gist", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/{sha}", "title": "Get a gist revision", "category": "gists", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" }, { "name": "sha", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", "sha": "SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "created_at": "2010-04-14T02:15:15Z", "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/gists", "title": "List gists for a user", "category": "gists", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists public gists for the specified user:
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "gists" } ], "comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/comments", "title": "List gist comments", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/gists/{gist_id}/comments", "title": "Create a gist comment", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" } ], "bodyParameters": [ { "description": "Required. The comment text.
", "type": "string", "maxLength": 65535, "examples": [ "Body of the attachment" ], "name": "body", "in": "body", "rawType": "string", "rawDescription": "The comment text.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gists/{gist_id}/comments/{comment_id}", "title": "Get a gist comment", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden Gist
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/gists/{gist_id}/comments/{comment_id}", "title": "Update a gist comment", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [ { "description": "Required. The comment text.
", "type": "string", "maxLength": 65535, "examples": [ "Body of the attachment" ], "name": "body", "in": "body", "rawType": "string", "rawDescription": "The comment text.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/gists/{gist_id}/comments/{comment_id}", "title": "Delete a gist comment", "category": "gists", "subcategory": "comments", "parameters": [ { "name": "gist_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "gist_id parameter
" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gist_id": "GIST_ID", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "git": { "blobs": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/blobs", "title": "Create a blob", "category": "git", "subcategory": "blobs", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The new blob's content.
", "name": "content", "in": "body", "rawType": "string", "rawDescription": "The new blob's content.", "childParamsGroups": [] }, { "type": "string", "description": "The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.
Response
", "example": { "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/blobs/{file_sha}", "title": "Get a blob", "category": "git", "subcategory": "blobs", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "file_sha", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "file_sha": "FILE_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", "encoding": "base64", "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", "size": 19, "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" } } } ], "previews": [], "descriptionHTML": "The content in the response will always be Base64 encoded.
Note: This API supports blobs up to 100 megabytes in size.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "commits": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/commits", "title": "Create a commit", "category": "git", "subcategory": "commits", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The commit message
", "name": "message", "in": "body", "rawType": "string", "rawDescription": "The commit message", "childParamsGroups": [] }, { "type": "string", "description": "Required. The SHA of the tree object this commit points to
", "name": "tree", "in": "body", "rawType": "string", "rawDescription": "The SHA of the tree object this commit points to", "childParamsGroups": [] }, { "type": "array of strings", "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.
", "items": { "type": "string" }, "name": "parents", "in": "body", "rawType": "array", "rawDescription": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", "childParamsGroups": [] }, { "type": "object", "description": "Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.
Required. The name of the author (or committer) of the commit
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author (or committer) of the commit", "childParamsGroups": [] }, "email": { "type": "string", "description": "Required. The email of the author (or committer) of the commit
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author (or committer) of the commit", "childParamsGroups": [] }, "date": { "type": "string", "format": "date-time", "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Required. The name of the author (or committer) of the commit
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author (or committer) of the commit", "childParamsGroups": [] }, { "type": "string", "description": "Required. The email of the author (or committer) of the commit
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author (or committer) of the commit", "childParamsGroups": [] }, { "type": "string", "format": "date-time", "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.
The name of the author (or committer) of the commit
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author (or committer) of the commit", "childParamsGroups": [] }, "email": { "type": "string", "description": "The email of the author (or committer) of the commit
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author (or committer) of the commit", "childParamsGroups": [] }, "date": { "type": "string", "format": "date-time", "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The name of the author (or committer) of the commit
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author (or committer) of the commit", "childParamsGroups": [] }, { "type": "string", "description": "The email of the author (or committer) of the commit
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author (or committer) of the commit", "childParamsGroups": [] }, { "type": "string", "format": "date-time", "description": "Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.
Response
", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "my commit message", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", "sha": "827efc6d56897b048c772eb4087f854f46256132" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null }, "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } } } ], "previews": [], "descriptionHTML": "Creates a new Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}", "title": "Get a commit", "category": "git", "subcategory": "commits", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "commit_sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "commit_sha parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "commit_sha": "COMMIT_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "added readme, because im a good github citizen", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", "sha": "691272480426f78a0138979dd3ce63b77f706feb" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } } } ], "previews": [], "descriptionHTML": "Gets a Git commit object.
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "refs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/matching-refs/{ref}", "title": "List matching references", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "ref parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "ref": "refs/heads/feature-a", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", "object": { "type": "commit", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" } }, { "ref": "refs/heads/feature-b", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", "object": { "type": "commit", "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" } } ] } } ], "previews": [], "descriptionHTML": "Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\nIf you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/ref/{ref}", "title": "Get a reference", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "ref parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", "object": { "type": "commit", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" } } } } ], "previews": [], "descriptionHTML": "Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/refs", "title": "Create a reference", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
Required. The SHA1 value for this reference.
", "name": "sha", "in": "body", "rawType": "string", "rawDescription": "The SHA1 value for this reference.", "childParamsGroups": [] }, { "type": "string", "examples": [ "\"refs/heads/newbranch\"" ], "name": "key", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "ref": "refs/heads/featureA", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", "object": { "type": "commit", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" } } } } ], "previews": [], "descriptionHTML": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", "title": "Update a reference", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "ref parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The SHA1 value to set this reference to
", "name": "sha", "in": "body", "rawType": "string", "rawDescription": "The SHA1 value to set this reference to", "childParamsGroups": [] }, { "type": "boolean", "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.
Response
", "example": { "ref": "refs/heads/featureA", "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", "object": { "type": "commit", "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/git/refs/{ref}", "title": "Delete a reference", "category": "git", "subcategory": "refs", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "ref parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "tags": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/tags", "title": "Create a tag object", "category": "git", "subcategory": "tags", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The tag's name. This is typically a version (e.g., \"v0.0.1\").
", "name": "tag", "in": "body", "rawType": "string", "rawDescription": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", "childParamsGroups": [] }, { "type": "string", "description": "Required. The tag message.
", "name": "message", "in": "body", "rawType": "string", "rawDescription": "The tag message.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The SHA of the git object this is tagging.
", "name": "object", "in": "body", "rawType": "string", "rawDescription": "The SHA of the git object this is tagging.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
An object with information about the individual creating the tag.
", "properties": { "name": { "type": "string", "description": "Required. The name of the author of the tag
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author of the tag", "childParamsGroups": [] }, "email": { "type": "string", "description": "Required. The email of the author of the tag
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author of the tag", "childParamsGroups": [] }, "date": { "type": "string", "format": "date-time", "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Required. The name of the author of the tag
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author of the tag", "childParamsGroups": [] }, { "type": "string", "description": "Required. The email of the author of the tag
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author of the tag", "childParamsGroups": [] }, { "type": "string", "format": "date-time", "description": "When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", "message": "initial version", "tagger": { "name": "Monalisa Octocat", "email": "octocat@github.com", "date": "2014-11-07T22:01:45Z" }, "object": { "type": "commit", "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" }, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } } } ], "previews": [], "descriptionHTML": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/tags/{tag_sha}", "title": "Get a tag", "category": "git", "subcategory": "tags", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "tag_sha", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "tag_sha": "TAG_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", "message": "initial version", "tagger": { "name": "Monalisa Octocat", "email": "octocat@github.com", "date": "2014-11-07T22:01:45Z" }, "object": { "type": "commit", "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" }, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } } } ], "previews": [], "descriptionHTML": "Signature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "trees": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/git/trees", "title": "Create a tree", "category": "git", "subcategory": "trees", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "array of objects", "description": "Required. Objects (of path, mode, type, and sha) specifying a tree structure.
The file referenced in the tree.
", "name": "path", "in": "body", "rawType": "string", "rawDescription": "The file referenced in the tree.", "childParamsGroups": [] }, "mode": { "type": "string", "description": "The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.
Either blob, tree, or commit.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The file referenced in the tree.
", "name": "path", "in": "body", "rawType": "string", "rawDescription": "The file referenced in the tree.", "childParamsGroups": [] }, { "type": "string", "description": "The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.
Either blob, tree, or commit.
The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.
Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.
The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.
Response
", "example": { "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", "tree": [ { "path": "file.rb", "mode": "100644", "type": "blob", "size": 132, "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" } ], "truncated": true } } } ], "previews": [], "descriptionHTML": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.
\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/git/trees/{tree_sha}", "title": "Get a tree", "category": "git", "subcategory": "trees", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "tree_sha", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "" }, { "name": "recursive", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in :tree_sha. For example, setting recursive to any of the following will enable returning objects or subtrees: 0, 1, \"true\", and \"false\". Omit this parameter to prevent recursively returning objects or subtrees.
Default response
", "example": { "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", "tree": [ { "path": "file.rb", "mode": "100644", "type": "blob", "size": 30, "sha": "44b4fc6d56897b048c772eb4087f854f46256132", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" }, { "path": "subdir", "mode": "040000", "type": "tree", "sha": "f484d249c660418515fb01c2b9662073663c242e", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" }, { "path": "exec_file", "mode": "100755", "type": "blob", "size": 75, "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" } ], "truncated": false } } }, { "key": "response-recursively-retrieving-a-tree", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "tree_sha": "TREE_SHA" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response recursively retrieving a tree
", "example": { "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", "tree": [ { "path": "subdir/file.txt", "mode": "100644", "type": "blob", "size": 132, "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" } ], "truncated": false } } } ], "previews": [], "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\nIf truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "gitignore": { "gitignore": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gitignore/templates", "title": "Get all gitignore templates", "category": "gitignore", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ "Actionscript", "Android", "AppceleratorTitanium", "Autotools", "Bancha", "C", "C++" ] } } ], "previews": [], "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "gitignore" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/gitignore/templates/{name}", "title": "Get a gitignore template", "category": "gitignore", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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" } } } ], "previews": [], "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "gitignore" } ] }, "interactions": { "orgs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/interaction-limits", "title": "Get interaction restrictions for an organization", "category": "interactions", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" } } } ], "previews": [], "descriptionHTML": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/interaction-limits", "title": "Set interaction restrictions for an organization", "category": "interactions", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: existing_users, contributors_only, collaborators_only.
The duration of the interaction restriction. Can be one of: one_day, three_days, one_week, one_month, six_months. Default: one_day.
Response
", "example": { "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" } } } ], "previews": [], "descriptionHTML": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/interaction-limits", "title": "Remove interaction restrictions for an organization", "category": "interactions", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "repos": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/interaction-limits", "title": "Get interaction restrictions for a repository", "category": "interactions", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "limit": "collaborators_only", "origin": "repository", "expires_at": "2018-08-17T04:18:39Z" } } } ], "previews": [], "descriptionHTML": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/interaction-limits", "title": "Set interaction restrictions for a repository", "category": "interactions", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: existing_users, contributors_only, collaborators_only.
The duration of the interaction restriction. Can be one of: one_day, three_days, one_week, one_month, six_months. Default: one_day.
Response
", "example": { "limit": "collaborators_only", "origin": "repository", "expires_at": "2018-08-17T04:18:39Z" } } } ], "previews": [], "descriptionHTML": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.
OK
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/interaction-limits", "title": "Remove interaction restrictions for a repository", "category": "interactions", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a 409 Conflict response and will not be able to use this endpoint to change the interaction limit for a single repository.
No Content
" }, { "httpStatusCode": "409", "description": "Conflict
" } ] } ], "user": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/interaction-limits", "title": "Get interaction restrictions for your public repositories", "category": "interactions", "subcategory": "user", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "limit": "collaborators_only", "origin": "organization", "expires_at": "2018-08-17T04:18:39Z" } } } ], "previews": [], "descriptionHTML": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Default response
" }, { "httpStatusCode": "204", "description": "Response when there are no restrictions
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/interaction-limits", "title": "Set interaction restrictions for your public repositories", "category": "interactions", "subcategory": "user", "parameters": [], "bodyParameters": [ { "type": "string", "description": "Required. The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: existing_users, contributors_only, collaborators_only.
The duration of the interaction restriction. Can be one of: one_day, three_days, one_week, one_month, six_months. Default: one_day.
Response
", "example": { "limit": "collaborators_only", "origin": "user", "expires_at": "2018-08-17T04:18:39Z" } } } ], "previews": [], "descriptionHTML": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/interaction-limits", "title": "Remove interaction restrictions from your public repositories", "category": "interactions", "subcategory": "user", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes any interaction restrictions from your public repositories.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ] }, "issues": { "issues": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/issues", "title": "List issues assigned to the authenticated user", "category": "issues", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "assigned", "created", "mentioned", "subscribed", "repos", "all" ], "default": "assigned" }, "descriptionHTML": "Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all or repos: All issues the authenticated user can see, regardless of participation or creation
Indicates the state of the issues to return. Can be either open, closed, or all.
A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created, updated, comments.
One of asc (ascending) or desc (descending).
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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, "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 }, "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "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.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe 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\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/issues", "title": "List organization issues assigned to the authenticated user", "category": "issues", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "assigned", "created", "mentioned", "subscribed", "repos", "all" ], "default": "assigned" }, "descriptionHTML": "Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all or repos: All issues the authenticated user can see, regardless of participation or creation
Indicates the state of the issues to return. Can be either open, closed, or all.
A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created, updated, comments.
One of asc (ascending) or desc (descending).
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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, "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 }, "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "List issues in an organization assigned to the authenticated user.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe 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\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues", "title": "List repository issues", "category": "issues", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "milestone", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.
Indicates the state of the issues to return. Can be either open, closed, or all.
Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.
The user that created the issue.
" }, { "name": "mentioned", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A user that's mentioned in the issue.
" }, { "name": "labels", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created, updated, comments.
One of asc (ascending) or desc (descending).
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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", "closed_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 }, "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "List issues in a repository.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe 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\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues", "title": "Create an issue", "category": "issues", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "description": "Required. The title of the issue.
", "name": "title", "in": "body", "type": "string or integer or ", "rawDescription": "The title of the issue.", "childParamsGroups": [] }, { "type": "string", "description": "The contents of the issue.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The contents of the issue.", "childParamsGroups": [] }, { "type": "string or null", "description": "Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
", "name": "assignee", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", "childParamsGroups": [] }, { "oneOf": [ { "type": "string" }, { "type": "integer", "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" } ], "type": "string or integer or null or string or integer", "name": "milestone", "in": "body", "rawType": [ "null", "string", "integer" ], "description": "The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.
Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.
", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "color": { "type": [ "string", "null" ] } } } ] }, "name": "labels", "in": "body", "rawType": "array", "rawDescription": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", "childParamsGroups": [] }, { "type": "array of strings", "description": "Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
", "items": { "type": "string" }, "name": "assignees", "in": "body", "rawType": "array", "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Found a bug", "body": "I'm having a problem with this.", "assignees": [ "octocat" ], "milestone": 1, "labels": [ "bug" ] }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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", "closed_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 }, "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", "title": "Get an issue", "category": "issues", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "closed_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 }, "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.
Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe 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\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}", "title": "Update an issue", "category": "issues", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [ { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "description": "The title of the issue.
", "type": "string or integer or null or string or integer", "name": "title", "in": "body", "rawType": [ "null", "string", "integer" ], "rawDescription": "The title of the issue.", "childParamsGroups": [] }, { "type": "string or null", "description": "The contents of the issue.
", "name": "body", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "The contents of the issue.", "childParamsGroups": [] }, { "type": "string or null", "description": "Login for the user that this issue should be assigned to. This field is deprecated.
", "name": "assignee", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "Login for the user that this issue should be assigned to. **This field is deprecated.**", "childParamsGroups": [] }, { "type": "string", "description": "State of the issue. Either open or closed.
The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.
Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.
Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
Response
", "example": { "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", "closed_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 }, "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "Issue owners and users with push access can edit an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", "title": "Lock an issue", "category": "issues", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [ { "type": "string", "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
\n* off-topic
\n* too heated
\n* resolved
\n* spam
Response
" } } ], "previews": [], "descriptionHTML": "Users with push access can lock an issue or pull request's conversation.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/lock", "title": "Unlock an issue", "category": "issues", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Users with push access can unlock an issue's conversation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "issues" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/issues", "title": "List user account issues assigned to the authenticated user", "category": "issues", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "assigned", "created", "mentioned", "subscribed", "repos", "all" ], "default": "assigned" }, "descriptionHTML": "Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all or repos: All issues the authenticated user can see, regardless of participation or creation
Indicates the state of the issues to return. Can be either open, closed, or all.
A list of comma separated label names. Example: bug,ui,@high
What to sort results by. Can be either created, updated, comments.
One of asc (ascending) or desc (descending).
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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, "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 }, "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "List issues across owned and member repositories assigned to the authenticated user.
\nNote: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe 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\nrequest id, use the \"List pull requests\" endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "issues" } ], "assignees": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees", "title": "List assignees", "category": "issues", "subcategory": "assignees", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists the available assignees for issues in a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/assignees/{assignee}", "title": "Check if a user can be assigned", "category": "issues", "subcategory": "assignees", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "assignee", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "assignee": "ASSIGNEE" } }, "response": { "statusCode": "204", "description": "If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
Checks if a user has permission to be assigned to an issue in this repository.
\nIf the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
Otherwise a 404 status code is returned.
If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.
Otherwise a 404 status code is returned.
issue_number parameter
" } ], "bodyParameters": [ { "type": "array of strings", "description": "Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.
", "items": { "type": "string" }, "name": "assignees", "in": "body", "rawType": "array", "rawDescription": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ "hubot", "other_user" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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", "closed_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 }, "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", "title": "Remove assignees from an issue", "category": "issues", "subcategory": "assignees", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [ { "type": "array of strings", "description": "Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.
", "items": { "type": "string" }, "name": "assignees", "in": "body", "rawType": "array", "rawDescription": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "assignees": [ "hubot", "other_user" ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "closed_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 }, "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "Removes one or more assignees from an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments", "title": "List issue comments for a repository", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ], "default": "created" }, "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
Either asc or desc. Ignored without the sort parameter.
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "By default, Issue Comments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "title": "Get an issue comment", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "title": "Update an issue comment", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The contents of the comment.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The contents of the comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "title": "Delete an issue comment", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", "title": "List issue comments", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "Issue Comments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/comments", "title": "Create an issue comment", "category": "issues", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The contents of the comment.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The contents of the comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Me too" }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "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-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "events": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events", "title": "List issue events for a repository", "category": "issues", "subcategory": "events", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", "actor": { "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 }, "event": "closed", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "created_at": "2011-04-14T16:00:49Z", "issue": { "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", "author_association": "COLLABORATOR" } } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/events/{event_id}", "title": "Get an issue event", "category": "issues", "subcategory": "events", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "event_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "event_id": "EVENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", "actor": { "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 }, "event": "closed", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "created_at": "2011-04-14T16:00:49Z", "issue": { "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, "performed_via_github_app": { "id": 1, "slug": "octoapp", "node_id": "MDExOkludGVncmF0aW9uMQ==", "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" ] }, "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", "author_association": "COLLABORATOR" } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events", "title": "List issue events", "category": "issues", "subcategory": "events", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDEwOklzc3VlRXZlbnQx", "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", "actor": { "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 }, "event": "closed", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "created_at": "2011-04-14T16:00:49Z", "performed_via_github_app": null, "label": { "name": "label", "color": "red" } } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "410", "description": "Gone
" } ] } ], "labels": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "title": "List labels for an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "title": "Add labels to an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [ { "type": "array of strings", "minItems": 1, "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"
Response
", "example": [ { "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 }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "title": "Set labels for an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [ { "type": "array of strings", "minItems": 1, "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"
Response
", "example": [ { "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 }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ] } } ], "previews": [], "descriptionHTML": "Removes any previous labels and sets the new labels for an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "title": "Remove all labels from an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", "title": "Remove a label from an issue", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels", "title": "List labels for a repository", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/labels", "title": "Create a label", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji ![\":strawberry:\"](\"https://github.githubassets.com/images/icons/emoji/unicode/1f353.png\" "\\":strawberry:\\""){kind=icon}
. For a full list of available emoji and codes, see \"Emoji cheat sheet.\"
The hexadecimal color code for the label, without the leading #.
A short description of the label. Must be 100 characters or fewer.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A short description of the label. Must be 100 characters or fewer.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "bug", "description": "Something isn't working", "color": "f29513" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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 } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/labels/{name}", "title": "Get a label", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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 } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/labels/{name}", "title": "Update a label", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji . For a full list of available emoji and codes, see \"Emoji cheat sheet.\"
The hexadecimal color code for the label, without the leading #.
A short description of the label. Must be 100 characters or fewer.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A short description of the label. Must be 100 characters or fewer.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_name": "bug :bug:", "description": "Small bug fix required", "color": "b01f26" }, "parameters": { "owner": "OWNER", "repo": "REPO", "name": "NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 208045946, "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:", "name": "bug :bug:", "description": "Small bug fix required", "color": "b01f26", "default": true } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/labels/{name}", "title": "Delete a label", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "name": "NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", "title": "List labels for issues in a milestone", "category": "issues", "subcategory": "labels", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "milestone_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "milestone_number parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "milestone_number": "MILESTONE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 }, { "id": 208045947, "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", "name": "enhancement", "description": "New feature or request", "color": "a2eeef", "default": false } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "milestones": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones", "title": "List milestones", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "all" ], "default": "open" }, "descriptionHTML": "The state of the milestone. Either open, closed, or all.
What to sort results by. Either due_on or completeness.
The direction of the sort. Either asc or desc.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/milestones", "title": "Create a milestone", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The title of the milestone.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "The title of the milestone.", "childParamsGroups": [] }, { "type": "string", "description": "The state of the milestone. Either open or closed.
A description of the milestone.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A description of the milestone.", "childParamsGroups": [] }, { "type": "string", "format": "date-time", "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": { "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" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", "title": "Get a milestone", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "milestone_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "milestone_number parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "milestone_number": "MILESTONE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", "title": "Update a milestone", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "milestone_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "milestone_number parameter
" } ], "bodyParameters": [ { "type": "string", "description": "The title of the milestone.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "The title of the milestone.", "childParamsGroups": [] }, { "type": "string", "description": "The state of the milestone. Either open or closed.
A description of the milestone.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A description of the milestone.", "childParamsGroups": [] }, { "type": "string", "format": "date-time", "description": "The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", "example": { "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" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}", "title": "Delete a milestone", "category": "issues", "subcategory": "milestones", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "milestone_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "milestone_number parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "milestone_number": "MILESTONE_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "timeline": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", "title": "List timeline events for an issue", "category": "issues", "subcategory": "timeline", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ] } ] }, "licenses": { "licenses": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/licenses", "title": "Get all commonly used licenses", "category": "licenses", "parameters": [ { "name": "featured", "in": "query", "required": false, "schema": { "type": "boolean" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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==" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "licenses" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/licenses/{license}", "title": "Get a license", "category": "licenses", "parameters": [ { "name": "license", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "license": "LICENSE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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 } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "licenses" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/license", "title": "Get the license for a repository", "category": "licenses", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "name": "LICENSE", "path": "LICENSE", "sha": "401c59dcc4570b954dd6d345e76199e1f4e76266", "size": 1077, "url": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", "html_url": "https://github.com/benbalter/gman/blob/master/LICENSE", "git_url": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", "download_url": "https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true", "type": "file", "content": "VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\n", "encoding": "base64", "_links": { "self": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", "git": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", "html": "https://github.com/benbalter/gman/blob/master/LICENSE" }, "license": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==" } } } } ], "previews": [], "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "licenses" } ] }, "markdown": { "markdown": [ { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/markdown", "title": "Render a Markdown document", "category": "markdown", "parameters": [], "bodyParameters": [ { "description": "Required. The Markdown text to render in HTML.
", "type": "string", "name": "text", "in": "body", "rawType": "string", "rawDescription": "The Markdown text to render in HTML.", "childParamsGroups": [] }, { "description": "The rendering mode. Can be either markdown or gfm.
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.
Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "markdown" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/markdown/raw", "title": "Render a Markdown document in raw mode", "category": "markdown", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [], "previews": [], "descriptionHTML": "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 is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "markdown" } ] }, "meta": { "meta": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/", "title": "GitHub API Root", "category": "meta", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "meta" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/meta", "title": "Get GitHub meta information", "category": "meta", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "verifiable_password_authentication": true, "ssh_key_fingerprints": { "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ", "SHA256_ECDSA": "p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM", "SHA256_ED25519": "+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU" }, "ssh_keys": [ "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl", "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEmKSENjQEezOmxkZMy7opKgwFB9nkt5YRrYMjNuG5N87uRgg6CLrbo5wAdT/y6v0mKV0U2w0WZ2YB/++Tpockg=", "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==" ], "hooks": [ "192.30.252.0/22" ], "web": [ "192.30.252.0/22", "185.199.108.0/22" ], "api": [ "192.30.252.0/22", "185.199.108.0/22" ], "git": [ "192.30.252.0/22" ], "packages": [ "192.30.252.0/22" ], "pages": [ "192.30.252.153/32", "192.30.252.154/32" ], "importer": [ "54.158.161.132", "54.226.70.38" ], "actions": [ "13.64.0.0/16", "13.65.0.0/16" ], "dependabot": [ "54.158.161.132" ] } } } ], "previews": [], "descriptionHTML": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"
\nNote: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "meta" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/octocat", "title": "Get Octocat", "category": "meta", "parameters": [ { "name": "s", "in": "query", "schema": { "type": "string" }, "required": false, "descriptionHTML": "The words to show in Octocat's speech bubble
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Get the octocat as ASCII art
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "meta" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/zen", "title": "Get the Zen of GitHub", "category": "meta", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Get a random sentence from the Zen of GitHub
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "meta" } ] }, "metrics": { "community": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/community/profile", "title": "Get community profile metrics", "category": "metrics", "subcategory": "community", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "health_percentage": 100, "description": "My first repository on GitHub!", "documentation": null, "files": { "code_of_conduct": { "name": "Contributor Covenant", "key": "contributor_covenant", "url": "https://api.github.com/codes_of_conduct/contributor_covenant", "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" }, "code_of_conduct_file": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md", "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" }, "contributing": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING", "html_url": "https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING" }, "issue_template": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE", "html_url": "https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE" }, "pull_request_template": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE", "html_url": "https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE" }, "license": { "name": "MIT License", "key": "mit", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "html_url": "https://github.com/octocat/Hello-World/blob/master/LICENSE", "node_id": "MDc6TGljZW5zZW1pdA==" }, "readme": { "url": "https://api.github.com/repos/octocat/Hello-World/contents/README.md", "html_url": "https://github.com/octocat/Hello-World/blob/master/README.md" } }, "updated_at": "2017-02-28T19:09:29Z", "content_reports_enabled": true } } } ], "previews": [], "descriptionHTML": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe health_percentage is 100. If only one is present, then the\nhealth_percentage is 25.
content_reports_enabled is only returned for organization-owned repositories.
OK
" } ] } ], "statistics": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/code_frequency", "title": "Get the weekly commit activity", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "example": [ [ 1302998400, 1124, -435 ] ] } } ], "previews": [], "descriptionHTML": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
" }, { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "204", "description": "A header with no content is returned.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/commit_activity", "title": "Get the last year of commit activity", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "days": [ 0, 3, 26, 20, 39, 1, 0 ], "total": 89, "week": 1336280400 } ] } } ], "previews": [], "descriptionHTML": "Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
OK
" }, { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "204", "description": "A header with no content is returned.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/contributors", "title": "Get all contributor commit activity", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "- \n
w- Start of the week, given as a Unix timestamp. \na- Number of additions \nd- Number of deletions \nc- Number of commits \n
Returns the total number of commits authored by the contributor. In addition, the response includes a Weekly Hash (weeks array) with the following information:
- \n
w- Start of the week, given as a Unix timestamp. \na- Number of additions \nd- Number of deletions \nc- Number of commits \n
- \n
w- Start of the week, given as a Unix timestamp. \na- Number of additions \nd- Number of deletions \nc- Number of commits \n
Accepted
" }, { "httpStatusCode": "204", "description": "A header with no content is returned.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/participation", "title": "Get the weekly commit count", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "The array order is oldest week (index 0) to most recent week.
", "example": { "all": [ 11, 21, 15, 2, 8, 1, 8, 23, 17, 21, 11, 10, 33, 91, 38, 34, 22, 23, 32, 3, 43, 87, 71, 18, 13, 5, 13, 16, 66, 27, 12, 45, 110, 117, 13, 8, 18, 9, 19, 26, 39, 12, 20, 31, 46, 91, 45, 10, 24, 9, 29, 7 ], "owner": [ 3, 2, 3, 0, 2, 0, 5, 14, 7, 9, 1, 5, 0, 48, 19, 2, 0, 1, 10, 2, 23, 40, 35, 8, 8, 2, 10, 6, 30, 0, 2, 9, 53, 104, 3, 3, 10, 4, 7, 11, 21, 4, 4, 22, 26, 63, 11, 2, 14, 1, 10, 3 ] } } } ], "previews": [], "descriptionHTML": "Returns the total commit counts for the owner and total commit counts in all. all is everyone combined, including the owner in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract owner from all.
The array order is oldest week (index 0) to most recent week.
", "statusCodes": [ { "httpStatusCode": "200", "description": "The array order is oldest week (index 0) to most recent week.
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/stats/punch_card", "title": "Get the hourly commit count for each day", "category": "metrics", "subcategory": "statistics", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Each array contains the day number, hour number, and number of commits:
\n- \n
0-6: Sunday - Saturday \n0-23: Hour of day \n- Number of commits \n
For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
A header with no content is returned.
" } ] } ], "traffic": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/traffic/clones", "title": "Get repository clones", "category": "metrics", "subcategory": "traffic", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "", "day", "week" ], "default": "day" }, "descriptionHTML": "Must be one of: day, week.
Response
", "example": { "count": 173, "uniques": 128, "clones": [ { "timestamp": "2016-10-10T00:00:00Z", "count": 2, "uniques": 1 }, { "timestamp": "2016-10-11T00:00:00Z", "count": 17, "uniques": 16 }, { "timestamp": "2016-10-12T00:00:00Z", "count": 21, "uniques": 15 }, { "timestamp": "2016-10-13T00:00:00Z", "count": 8, "uniques": 7 }, { "timestamp": "2016-10-14T00:00:00Z", "count": 5, "uniques": 5 }, { "timestamp": "2016-10-15T00:00:00Z", "count": 2, "uniques": 2 }, { "timestamp": "2016-10-16T00:00:00Z", "count": 8, "uniques": 7 }, { "timestamp": "2016-10-17T00:00:00Z", "count": 26, "uniques": 15 }, { "timestamp": "2016-10-18T00:00:00Z", "count": 19, "uniques": 17 }, { "timestamp": "2016-10-19T00:00:00Z", "count": 19, "uniques": 14 }, { "timestamp": "2016-10-20T00:00:00Z", "count": 19, "uniques": 15 }, { "timestamp": "2016-10-21T00:00:00Z", "count": 9, "uniques": 7 }, { "timestamp": "2016-10-22T00:00:00Z", "count": 5, "uniques": 5 }, { "timestamp": "2016-10-23T00:00:00Z", "count": 6, "uniques": 5 }, { "timestamp": "2016-10-24T00:00:00Z", "count": 7, "uniques": 5 } ] } } } ], "previews": [], "descriptionHTML": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/traffic/popular/paths", "title": "Get top referral paths", "category": "metrics", "subcategory": "traffic", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "path": "/github/hubot", "title": "github/hubot: A customizable life embetterment robot.", "count": 3542, "uniques": 2225 }, { "path": "/github/hubot/blob/master/docs/scripting.md", "title": "hubot/scripting.md at master · github/hubot · GitHub", "count": 1707, "uniques": 804 }, { "path": "/github/hubot/tree/master/docs", "title": "hubot/docs at master · github/hubot · GitHub", "count": 685, "uniques": 435 }, { "path": "/github/hubot/tree/master/src", "title": "hubot/src at master · github/hubot · GitHub", "count": 577, "uniques": 347 }, { "path": "/github/hubot/blob/master/docs/index.md", "title": "hubot/index.md at master · github/hubot · GitHub", "count": 379, "uniques": 259 }, { "path": "/github/hubot/blob/master/docs/adapters.md", "title": "hubot/adapters.md at master · github/hubot · GitHub", "count": 354, "uniques": 201 }, { "path": "/github/hubot/tree/master/examples", "title": "hubot/examples at master · github/hubot · GitHub", "count": 340, "uniques": 260 }, { "path": "/github/hubot/blob/master/docs/deploying/heroku.md", "title": "hubot/heroku.md at master · github/hubot · GitHub", "count": 324, "uniques": 217 }, { "path": "/github/hubot/blob/master/src/robot.coffee", "title": "hubot/robot.coffee at master · github/hubot · GitHub", "count": 293, "uniques": 191 }, { "path": "/github/hubot/blob/master/LICENSE.md", "title": "hubot/LICENSE.md at master · github/hubot · GitHub", "count": 281, "uniques": 222 } ] } } ], "previews": [], "descriptionHTML": "Get the top 10 popular contents over the last 14 days.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/traffic/popular/referrers", "title": "Get top referral sources", "category": "metrics", "subcategory": "traffic", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "referrer": "Google", "count": 4, "uniques": 3 }, { "referrer": "stackoverflow.com", "count": 2, "uniques": 2 }, { "referrer": "eggsonbread.com", "count": 1, "uniques": 1 }, { "referrer": "yandex.ru", "count": 1, "uniques": 1 } ] } } ], "previews": [], "descriptionHTML": "Get the top 10 referrers over the last 14 days.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/traffic/views", "title": "Get page views", "category": "metrics", "subcategory": "traffic", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "", "day", "week" ], "default": "day" }, "descriptionHTML": "Must be one of: day, week.
Response
", "example": { "count": 14850, "uniques": 3782, "views": [ { "timestamp": "2016-10-10T00:00:00Z", "count": 440, "uniques": 143 }, { "timestamp": "2016-10-11T00:00:00Z", "count": 1308, "uniques": 414 }, { "timestamp": "2016-10-12T00:00:00Z", "count": 1486, "uniques": 452 }, { "timestamp": "2016-10-13T00:00:00Z", "count": 1170, "uniques": 401 }, { "timestamp": "2016-10-14T00:00:00Z", "count": 868, "uniques": 266 }, { "timestamp": "2016-10-15T00:00:00Z", "count": 495, "uniques": 157 }, { "timestamp": "2016-10-16T00:00:00Z", "count": 524, "uniques": 175 }, { "timestamp": "2016-10-17T00:00:00Z", "count": 1263, "uniques": 412 }, { "timestamp": "2016-10-18T00:00:00Z", "count": 1402, "uniques": 417 }, { "timestamp": "2016-10-19T00:00:00Z", "count": 1394, "uniques": 424 }, { "timestamp": "2016-10-20T00:00:00Z", "count": 1492, "uniques": 448 }, { "timestamp": "2016-10-21T00:00:00Z", "count": 1153, "uniques": 332 }, { "timestamp": "2016-10-22T00:00:00Z", "count": 566, "uniques": 168 }, { "timestamp": "2016-10-23T00:00:00Z", "count": 675, "uniques": 184 }, { "timestamp": "2016-10-24T00:00:00Z", "count": 614, "uniques": 237 } ] } } } ], "previews": [], "descriptionHTML": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] } ] }, "migrations": { "orgs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/migrations", "title": "List organization migrations", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "description": "Allowed values that can be passed to the exclude param.", "enum": [ "repositories" ], "type": "string", "examples": [ "repositories" ] } }, "descriptionHTML": "Exclude attributes from the API response to improve performance
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 79, "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 }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "pending", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00", "node_id": "MDQ6VXNlcjE=" } ] } } ], "previews": [], "descriptionHTML": "Lists the most recent migrations.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/migrations", "title": "Start an organization migration", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. A list of arrays indicating which repositories should be migrated.
", "items": { "type": "string" }, "name": "repositories", "in": "body", "rawType": "array", "rawDescription": "A list of arrays indicating which repositories should be migrated.", "childParamsGroups": [] }, { "type": "boolean", "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
", "default": false, "examples": [ true ], "name": "lock_repositories", "in": "body", "rawType": "boolean", "rawDescription": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", "childParamsGroups": [] }, { "type": "boolean", "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
", "default": false, "examples": [ true ], "name": "exclude_attachments", "in": "body", "rawType": "boolean", "rawDescription": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", "childParamsGroups": [] }, { "type": "boolean", "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).
", "default": false, "examples": [ true ], "name": "exclude_releases", "in": "body", "rawType": "boolean", "rawDescription": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", "childParamsGroups": [] }, { "type": "boolean", "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.
", "default": false, "examples": [ true ], "name": "exclude_owner_projects", "in": "body", "rawType": "boolean", "rawDescription": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", "childParamsGroups": [] }, { "type": "array of strings", "items": { "type": "string", "enum": [ "repositories" ] }, "name": "exclude", "in": "body", "rawType": "array", "description": "", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "repositories": [ "github/Hello-World" ], "lock_repositories": true }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "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 }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "pending", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00" } } } ], "previews": [], "descriptionHTML": "Initiates the generation of a migration archive.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/migrations/{migration_id}", "title": "Get an organization migration status", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "description": "Allowed values that can be passed to the exclude param.", "enum": [ "repositories" ], "type": "string", "examples": [ "repositories" ] } }, "descriptionHTML": "Exclude attributes from the API response to improve performance
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "- \n
pending, which means the migration hasn't started yet. \nexporting, which means the migration is in progress. \nexported, which means the migration finished successfully. \nfailed, which means the migration failed. \n
Fetches the status of a migration.
\nThe state of a migration can be one of the following values:
- \n
pending, which means the migration hasn't started yet. \nexporting, which means the migration is in progress. \nexported, which means the migration finished successfully. \nfailed, which means the migration failed. \n
- \n
pending, which means the migration hasn't started yet. \nexporting, which means the migration is in progress. \nexported, which means the migration finished successfully. \nfailed, which means the migration failed. \n
Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", "title": "Download an organization migration archive", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Fetches the URL to a migration archive.
", "statusCodes": [ { "httpStatusCode": "302", "description": "Found
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/migrations/{migration_id}/archive", "title": "Delete an organization migration archive", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", "title": "Unlock an organization repository", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" }, { "name": "repo_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "repo_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID", "repo_name": "REPO_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/migrations/{migration_id}/repositories", "title": "List repositories in an organization migration", "category": "migrations", "subcategory": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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": false, "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": null } ] } } ], "previews": [], "descriptionHTML": "List all the repositories for this organization migration.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "source-imports": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/import", "title": "Get an import status", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "complete", "status_text": "Done", "has_large_files": true, "large_files_size": 132331036, "large_files_count": 1, "authors_count": 4, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" } } } ], "previews": [], "descriptionHTML": "View the progress of an import.
\nImport status
\nThis section includes details about the possible values of the status field of the Import Progress response.
An import that does not have errors will progress through these steps:
\n- \n
detecting- the \"detection\" step of the import is in progress because the request did not include avcsparameter. The import is identifying the type of source control present at the URL. \nimporting- the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will includecommit_count(the total number of raw commits that will be imported) andpercent(0 - 100, the current progress through the import). \nmapping- the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. \npushing- the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will includepush_percent, which is the percent value reported bygit pushwhen it is \"Writing objects\". \ncomplete- the import is complete, and the repository is ready on GitHub. \n
If there are problems, you will see one of these in the status field:
- \n
auth_failed- the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section. \nerror- the import encountered an error. The import progress response will include thefailed_stepand an error message. Contact GitHub Support for more information. \ndetection_needs_auth- the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section. \ndetection_found_nothing- the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL. \ndetection_found_multiple- the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include aproject_choicesfield with the possible project choices as values. To update project choice, please see the Update an import section. \n
The project_choices field
\nWhen multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.
Git LFS related fields
\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.
\n- \n
use_lfs- describes whether the import has been opted in or out of using Git LFS. The value can beopt_in,opt_out, orundecidedif no action has been taken. \nhas_large_files- the boolean value describing whether files larger than 100MB were found during theimportingstep. \nlarge_files_size- the total size in gigabytes of files larger than 100MB found in the originating repository. \nlarge_files_count- the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request. \n
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/import", "title": "Start an import", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The URL of the originating repository.
", "name": "vcs_url", "in": "body", "rawType": "string", "rawDescription": "The URL of the originating repository.", "childParamsGroups": [] }, { "type": "string", "description": "The originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.
If authentication is required, the username to provide to vcs_url.
If authentication is required, the password to provide to vcs_url.
For a tfvc import, the name of the project that is being imported.
", "name": "tfvc_project", "in": "body", "rawType": "string", "rawDescription": "For a tfvc import, the name of the project that is being imported.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs": "subversion", "vcs_url": "http://svn.mycompany.com/svn/myproject", "vcs_username": "octocat", "vcs_password": "secret" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "importing", "status_text": "Importing...", "has_large_files": false, "large_files_size": 0, "large_files_count": 0, "authors_count": 0, "commit_count": 1042, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" } } } ], "previews": [], "descriptionHTML": "Start a source import to a GitHub repository using GitHub Importer.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/import", "title": "Update an import", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The username to provide to the originating repository.
", "name": "vcs_username", "in": "body", "rawType": "string", "rawDescription": "The username to provide to the originating repository.", "childParamsGroups": [] }, { "type": "string", "description": "The password to provide to the originating repository.
", "name": "vcs_password", "in": "body", "rawType": "string", "rawDescription": "The password to provide to the originating repository.", "childParamsGroups": [] }, { "type": "string", "description": "The type of version control system you are migrating from.
", "enum": [ "subversion", "tfvc", "git", "mercurial" ], "examples": [ "\"git\"" ], "name": "vcs", "in": "body", "rawType": "string", "rawDescription": "The type of version control system you are migrating from.", "childParamsGroups": [] }, { "type": "string", "description": "For a tfvc import, the name of the project that is being imported.
", "examples": [ "\"project1\"" ], "name": "tfvc_project", "in": "body", "rawType": "string", "rawDescription": "For a tfvc import, the name of the project that is being imported.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "example-1", "request": { "contentType": "application/json", "description": "Update authentication for an import", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs_username": "octocat", "vcs_password": "secret" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Example 1
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "detecting", "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" } } }, { "key": "example-2", "request": { "contentType": "application/json", "description": "Updating the project choice", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "vcs": "tfvc", "tfvc_project": "project1", "human_name": "project1 (tfs)" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Example 2
", "example": { "vcs": "tfvc", "use_lfs": true, "vcs_url": "http://tfs.mycompany.com/tfs/myproject", "tfvc_project": "project1", "status": "importing", "status_text": "Importing...", "has_large_files": false, "large_files_size": 0, "large_files_count": 0, "authors_count": 0, "commit_count": 1042, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" } } }, { "key": "example-3", "request": { "contentType": "application/json", "description": "Restarting an import", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "importing", "status_text": "Importing...", "has_large_files": false, "large_files_size": 0, "large_files_count": 0, "authors_count": 0, "commit_count": 1042, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" } } } ], "previews": [], "descriptionHTML": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.
\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/import", "title": "Cancel an import", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Stop an import for a repository.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/import/authors", "title": "Get commit authors", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "since", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "A user ID. Only return users with an ID greater than this ID.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 2268557, "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "remote_name": "nobody", "email": "hubot@github.com", "name": "Hubot", "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", "import_url": "https://api.github.com/repos/octocat/socm/import" }, { "id": 2268558, "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "remote_name": "svner", "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "name": "svner", "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558", "import_url": "https://api.github.com/repos/octocat/socm/import" }, { "id": 2268559, "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "remote_name": "svner@example.com", "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "name": "svner@example.com", "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559", "import_url": "https://api.github.com/repos/octocat/socm/import" } ] } } ], "previews": [], "descriptionHTML": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.
This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/import/authors/{author_id}", "title": "Map a commit author", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "author_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The new Git author email.
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The new Git author email.", "childParamsGroups": [] }, { "type": "string", "description": "The new Git author name.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The new Git author name.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "email": "hubot@github.com", "name": "Hubot the Robot" }, "parameters": { "owner": "OWNER", "repo": "REPO", "author_id": "AUTHOR_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 2268557, "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", "remote_name": "nobody", "email": "hubot@github.com", "name": "Hubot", "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", "import_url": "https://api.github.com/repos/octocat/socm/import" } } } ], "previews": [], "descriptionHTML": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/import/large_files", "title": "Get large files", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "ref_name": "refs/heads/master", "path": "foo/bar/1", "oid": "d3d9446802a44259755d38e6d163e820", "size": 10485760 }, { "ref_name": "refs/heads/master", "path": "foo/bar/2", "oid": "6512bd43d9caa6e02c990b0a82652dca", "size": 11534336 }, { "ref_name": "refs/heads/master", "path": "foo/bar/3", "oid": "c20ad4d76fe97759aa27a0c99bff6710", "size": 12582912 } ] } } ], "previews": [], "descriptionHTML": "List files larger than 100MB found during the import
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/import/lfs", "title": "Update Git LFS preference", "category": "migrations", "subcategory": "source-imports", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).
Response
", "example": { "vcs": "subversion", "use_lfs": true, "vcs_url": "http://svn.mycompany.com/svn/myproject", "status": "complete", "status_text": "Done", "has_large_files": true, "large_files_size": 132331036, "large_files_count": 1, "authors_count": 4, "url": "https://api.github.com/repos/octocat/socm/import", "html_url": "https://import.github.com/octocat/socm/import", "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", "repository_url": "https://api.github.com/repos/octocat/socm" } } } ], "previews": [], "descriptionHTML": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "users": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/migrations", "title": "List user migrations", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 79, "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 }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "pending", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00", "node_id": "MDQ6VXNlcjE=" } ] } } ], "previews": [], "descriptionHTML": "Lists all migrations a user has started.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/migrations", "title": "Start a user migration", "category": "migrations", "subcategory": "users", "parameters": [], "bodyParameters": [ { "description": "Lock the repositories being migrated at the start of the migration
", "readOnly": false, "type": "boolean", "examples": [ true ], "name": "lock_repositories", "in": "body", "rawType": "boolean", "rawDescription": "Lock the repositories being migrated at the start of the migration", "childParamsGroups": [] }, { "description": "Do not include attachments in the migration
", "readOnly": false, "type": "boolean", "examples": [ true ], "name": "exclude_attachments", "in": "body", "rawType": "boolean", "rawDescription": "Do not include attachments in the migration", "childParamsGroups": [] }, { "description": "Do not include releases in the migration
", "readOnly": false, "type": "boolean", "examples": [ true ], "name": "exclude_releases", "in": "body", "rawType": "boolean", "rawDescription": "Do not include releases in the migration", "childParamsGroups": [] }, { "description": "Indicates whether projects owned by the organization or users should be excluded.
", "readOnly": false, "type": "boolean", "examples": [ true ], "name": "exclude_owner_projects", "in": "body", "rawType": "boolean", "rawDescription": "Indicates whether projects owned by the organization or users should be excluded.", "childParamsGroups": [] }, { "description": "Exclude attributes from the API response to improve performance
", "readOnly": false, "type": "array of strings", "items": { "description": "Allowed values that can be passed to the exclude param.", "enum": [ "repositories" ], "type": "string", "examples": [ "repositories" ] }, "examples": [ "repositories" ], "name": "exclude", "in": "body", "rawType": "array", "rawDescription": "Exclude attributes from the API response to improve performance", "childParamsGroups": [] }, { "type": "array of strings", "items": { "description": "Repository path, owner and name", "type": "string", "examples": [ "acme/widgets" ] }, "name": "repositories", "in": "body", "rawType": "array", "description": "Required.
", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "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 }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "pending", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00" } } } ], "previews": [], "descriptionHTML": "Initiates the generation of a user migration archive.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/migrations/{migration_id}", "title": "Get a user migration status", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 79, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "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 }, "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "state": "exported", "lock_repositories": true, "exclude_attachments": false, "exclude_releases": false, "exclude_owner_projects": false, "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ], "url": "https://api.github.com/orgs/octo-org/migrations/79", "created_at": "2015-07-06T15:33:38-07:00", "updated_at": "2015-07-06T15:33:38-07:00" } } } ], "previews": [], "descriptionHTML": "Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:
- \n
pending- the migration hasn't started yet. \nexporting- the migration is in progress. \nexported- the migration finished successfully. \nfailed- the migration failed. \n
Once the migration has been exported you can download the migration archive.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/migrations/{migration_id}/archive", "title": "Download a user migration archive", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [], "previews": [], "descriptionHTML": "Fetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:
- \n
- attachments \n
- bases \n
- commit_comments \n
- issue_comments \n
- issue_events \n
- issues \n
- milestones \n
- organizations \n
- projects \n
- protected_branches \n
- pull_request_reviews \n
- pull_requests \n
- releases \n
- repositories \n
- review_comments \n
- schema \n
- users \n
The archive will also contain an attachments directory that includes all attachment files uploaded to GitHub.com and a repositories directory that contains the repository's Git data.
Found
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/migrations/{migration_id}/archive", "title": "Delete a user migration archive", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get a user migration status endpoints, will continue to be available even after an archive is deleted.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/migrations/{migration_id}/repos/{repo_name}/lock", "title": "Unlock a user repository", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" }, { "name": "repo_name", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "repo_name parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID", "repo_name": "REPO_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/migrations/{migration_id}/repositories", "title": "List repositories for a user migration", "category": "migrations", "subcategory": "users", "parameters": [ { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "migration_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "migration_id": "MIGRATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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": false, "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": null } ] } } ], "previews": [], "descriptionHTML": "Lists all the repositories for this user migration.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "oauth-authorizations": { "oauth-authorizations": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/applications/grants", "title": "List your grants", "category": "oauth-authorizations", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "The client ID of your GitHub app.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "url": "https://api.github.com/applications/grants/1", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "created_at": "2011-09-06T17:26:27Z", "updated_at": "2011-09-06T20:39:23Z", "scopes": [ "public_repo" ] } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/applications/grants/{grant_id}", "title": "Get a single grant", "category": "oauth-authorizations", "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "grant_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/applications/grants/1", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "created_at": "2011-09-06T17:26:27Z", "updated_at": "2011-09-06T20:39:23Z", "scopes": [ "public_repo" ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/applications/grants/{grant_id}", "title": "Delete a grant", "category": "oauth-authorizations", "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "grant_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "grant_id": "GRANT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/authorizations", "title": "List your authorizations", "category": "oauth-authorizations", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "The client ID of your GitHub app.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2011-09-08T17:26:27Z", "fingerprint": "jklmnop12345678" } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/authorizations", "title": "Create a new authorization", "category": "oauth-authorizations", "parameters": [], "bodyParameters": [ { "description": "A list of scopes that this authorization is in.
", "type": "array of strings or null", "items": { "type": "string" }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", "rawType": [ "array", "null" ], "rawDescription": "A list of scopes that this authorization is in.", "childParamsGroups": [] }, { "description": "A note to remind you what the OAuth token is for.
", "type": "string", "examples": [ "Update all gems" ], "name": "note", "in": "body", "rawType": "string", "rawDescription": "A note to remind you what the OAuth token is for.", "childParamsGroups": [] }, { "description": "A URL to remind you what app the OAuth token is for.
", "type": "string", "name": "note_url", "in": "body", "rawType": "string", "rawDescription": "A URL to remind you what app the OAuth token is for.", "childParamsGroups": [] }, { "description": "The OAuth app client key for which to create the token.
", "maxLength": 20, "type": "string", "name": "client_id", "in": "body", "rawType": "string", "rawDescription": "The OAuth app client key for which to create the token.", "childParamsGroups": [] }, { "description": "The OAuth app client secret for which to create the token.
", "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", "rawType": "string", "rawDescription": "The OAuth app client secret for which to create the token.", "childParamsGroups": [] }, { "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
", "type": "string", "name": "fingerprint", "in": "body", "rawType": "string", "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2011-10-06T17:26:27Z", "fingerprint": "" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/authorizations/clients/{client_id}", "title": "Get-or-create an authorization for a specific app", "category": "oauth-authorizations", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } }, "descriptionHTML": "The client ID of your GitHub app.
" } ], "bodyParameters": [ { "description": "Required. The OAuth app client secret for which to create the token.
", "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", "rawType": "string", "rawDescription": "The OAuth app client secret for which to create the token.", "childParamsGroups": [] }, { "description": "A list of scopes that this authorization is in.
", "type": "array of strings or null", "items": { "type": "string" }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", "rawType": [ "array", "null" ], "rawDescription": "A list of scopes that this authorization is in.", "childParamsGroups": [] }, { "description": "A note to remind you what the OAuth token is for.
", "type": "string", "examples": [ "Update all gems" ], "name": "note", "in": "body", "rawType": "string", "rawDescription": "A note to remind you what the OAuth token is for.", "childParamsGroups": [] }, { "description": "A URL to remind you what app the OAuth token is for.
", "type": "string", "name": "note_url", "in": "body", "rawType": "string", "rawDescription": "A URL to remind you what app the OAuth token is for.", "childParamsGroups": [] }, { "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
", "type": "string", "name": "fingerprint", "in": "body", "rawType": "string", "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if returning an existing token
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2011-10-06T17:26:27Z", "fingerprint": "" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2011-10-06T17:26:27Z", "fingerprint": "" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nDeprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "200", "description": "if returning an existing token
" }, { "httpStatusCode": "201", "description": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/authorizations/clients/{client_id}/{fingerprint}", "title": "Get-or-create an authorization for a specific app and fingerprint", "category": "oauth-authorizations", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "Iv1.8a61f9b3a7aba766" } }, "descriptionHTML": "The client ID of your GitHub app.
" }, { "name": "fingerprint", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "description": "Required. The OAuth app client secret for which to create the token.
", "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", "rawType": "string", "rawDescription": "The OAuth app client secret for which to create the token.", "childParamsGroups": [] }, { "description": "A list of scopes that this authorization is in.
", "type": "array of strings or null", "items": { "type": "string" }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", "rawType": [ "array", "null" ], "rawDescription": "A list of scopes that this authorization is in.", "childParamsGroups": [] }, { "description": "A note to remind you what the OAuth token is for.
", "type": "string", "examples": [ "Update all gems" ], "name": "note", "in": "body", "rawType": "string", "rawDescription": "A note to remind you what the OAuth token is for.", "childParamsGroups": [] }, { "description": "A URL to remind you what app the OAuth token is for.
", "type": "string", "name": "note_url", "in": "body", "rawType": "string", "rawDescription": "A URL to remind you what app the OAuth token is for.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", "fingerprint": "FINGERPRINT" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if returning an existing token
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2011-10-06T17:26:27Z", "fingerprint": "jklmnop12345678" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "client_id": "Iv1.8a61f9b3a7aba766", "fingerprint": "FINGERPRINT" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response if returning a new token
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2012-10-06T17:26:27Z", "fingerprint": "jklmnop12345678" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "if returning an existing token
" }, { "httpStatusCode": "201", "description": "Response if returning a new token
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/authorizations/{authorization_id}", "title": "Get a single authorization", "category": "oauth-authorizations", "parameters": [ { "name": "authorization_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "authorization_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2011-10-06T17:26:27Z", "fingerprint": "jklmnop12345678" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/authorizations/{authorization_id}", "title": "Update an existing authorization", "category": "oauth-authorizations", "parameters": [ { "name": "authorization_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "authorization_id parameter
" } ], "bodyParameters": [ { "description": "A list of scopes that this authorization is in.
", "type": "array of strings or null", "items": { "type": "string" }, "examples": [ "public_repo", "user" ], "name": "scopes", "in": "body", "rawType": [ "array", "null" ], "rawDescription": "A list of scopes that this authorization is in.", "childParamsGroups": [] }, { "description": "A list of scopes to add to this authorization.
", "type": "array of strings", "items": { "type": "string" }, "name": "add_scopes", "in": "body", "rawType": "array", "rawDescription": "A list of scopes to add to this authorization.", "childParamsGroups": [] }, { "description": "A list of scopes to remove from this authorization.
", "type": "array of strings", "items": { "type": "string" }, "name": "remove_scopes", "in": "body", "rawType": "array", "rawDescription": "A list of scopes to remove from this authorization.", "childParamsGroups": [] }, { "description": "A note to remind you what the OAuth token is for.
", "type": "string", "examples": [ "Update all gems" ], "name": "note", "in": "body", "rawType": "string", "rawDescription": "A note to remind you what the OAuth token is for.", "childParamsGroups": [] }, { "description": "A URL to remind you what app the OAuth token is for.
", "type": "string", "name": "note_url", "in": "body", "rawType": "string", "rawDescription": "A URL to remind you what app the OAuth token is for.", "childParamsGroups": [] }, { "description": "A unique string to distinguish an authorization from others created for the same client ID and user.
", "type": "string", "name": "fingerprint", "in": "body", "rawType": "string", "rawDescription": "A unique string to distinguish an authorization from others created for the same client ID and user.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", "scopes": [ "public_repo" ], "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", "token_last_eight": "Ae178B4a", "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", "app": { "url": "http://my-github-app.com", "name": "my github app", "client_id": "abcde12345fghij67890" }, "note": "optional note", "note_url": "http://optional/note/url", "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "expires_at": "2011-10-06T17:26:27Z", "fingerprint": "jklmnop12345678" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "oauth-authorizations" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/authorizations/{authorization_id}", "title": "Delete an authorization", "category": "oauth-authorizations", "parameters": [ { "name": "authorization_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "authorization_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "authorization_id": "AUTHORIZATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "oauth-authorizations" } ] }, "orgs": { "orgs": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/organizations", "title": "List organizations", "category": "orgs", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "An organization ID. Only return organizations with an ID greater than this ID.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" } ] } } ], "previews": [], "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}", "title": "Get an organization", "category": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "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", "updated_at": "2014-03-03T18:58:10Z", "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", "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_fork_private_repositories": false } } } ], "previews": [], "descriptionHTML": "To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub plan information' below.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}", "title": "Update an organization", "category": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Billing email address. This address is not publicized.
", "name": "billing_email", "in": "body", "rawType": "string", "rawDescription": "Billing email address. This address is not publicized.", "childParamsGroups": [] }, { "type": "string", "description": "The company name.
", "name": "company", "in": "body", "rawType": "string", "rawDescription": "The company name.", "childParamsGroups": [] }, { "type": "string", "description": "The publicly visible email address.
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The publicly visible email address.", "childParamsGroups": [] }, { "type": "string", "description": "The Twitter username of the company.
", "name": "twitter_username", "in": "body", "rawType": "string", "rawDescription": "The Twitter username of the company.", "childParamsGroups": [] }, { "type": "string", "description": "The location.
", "name": "location", "in": "body", "rawType": "string", "rawDescription": "The location.", "childParamsGroups": [] }, { "type": "string", "description": "The shorthand name of the company.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The shorthand name of the company.", "childParamsGroups": [] }, { "type": "string", "description": "The description of the company.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "The description of the company.", "childParamsGroups": [] }, { "type": "boolean", "description": "Toggles whether an organization can use organization projects.
", "name": "has_organization_projects", "in": "body", "rawType": "boolean", "rawDescription": "Toggles whether an organization can use organization projects.", "childParamsGroups": [] }, { "type": "boolean", "description": "Toggles whether repositories that belong to the organization can use repository projects.
", "name": "has_repository_projects", "in": "body", "rawType": "boolean", "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.", "childParamsGroups": [] }, { "type": "string", "description": "Default permission level members have for organization repositories:
\n* read - can pull, but not push to or administer this repository.
\n* write - can pull and push, but not administer this repository.
\n* admin - can pull, push, and administer this repository.
\n* none - no permissions granted by default.
Toggles the ability of non-admin organization members to create repositories. Can be one of:
\n* true - all organization members can create repositories.
\n* false - only organization owners can create repositories.
\nDefault: true
\nNote: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.
Toggles 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+. Can be one of:
\n* true - all organization members can create internal repositories.
\n* false - only organization owners can create internal repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of:
\n* true - all organization members can create private repositories.
\n* false - only organization owners can create private repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of:
\n* true - all organization members can create public repositories.
\n* false - only organization owners can create public repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
Specifies which types of repositories non-admin organization members can create. Can be one of:
\n* all - all organization members can create public and private repositories.
\n* private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
\n* none - only admin members can create repositories.
\nNote: This parameter is deprecated 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.
Toggles whether organization members can create GitHub Pages sites. Can be one of:
\n* true - all organization members can create GitHub Pages sites.
\n* false - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.
Toggles whether organization members can create public GitHub Pages sites. Can be one of:
\n* true - all organization members can create public GitHub Pages sites.
\n* false - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.
Toggles whether organization members can create private GitHub Pages sites. Can be one of:
\n* true - all organization members can create private GitHub Pages sites.
\n* false - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.
Toggles whether organization members can fork private organization repositories. Can be one of:
\n* true - all organization members can fork private repositories within the organization.
\n* false - no organization members can fork private repositories within the organization.
Response
", "example": { "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 }, "default_repository_permission": "read", "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_fork_private_repositories": false, "updated_at": "2014-03-03T18:58:10Z" } } } ], "previews": [], "descriptionHTML": "Parameter Deprecation 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.
Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
OK
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/audit-log", "title": "Get the audit log for an organization", "category": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "phrase", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A search phrase. For more information, see Searching the audit log.
" }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "web", "git", "all" ] }, "descriptionHTML": "The event types to include:
\n- \n
web- returns web (non-Git) events. \ngit- returns Git events. \nall- returns both web and Git events. \n
The default is web.
A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
" }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
" }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] }, "descriptionHTML": "The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
The default is desc.
Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "@timestamp": 1606929874512, "action": "team.add_member", "actor": "octocat", "created_at": 1606929874512, "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", "org": "octo-corp", "team": "octo-corp/example-team", "user": "monalisa" }, { "@timestamp": 1606507117008, "action": "org.create", "actor": "octocat", "created_at": 1606507117008, "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", "org": "octocat-test-org" }, { "@timestamp": 1605719148837, "action": "repo.destroy", "actor": "monalisa", "created_at": 1605719148837, "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", "org": "mona-org", "repo": "mona-org/mona-test-repo", "visibility": "private" } ] } } ], "previews": [], "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nThis endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the admin:org scope. GitHub Apps must have the organization_administration read permission to use this endpoint.
By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Resources in the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/credential-authorizations", "title": "List SAML SSO authorizations for an organization", "category": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "descriptionHTML": "Page token
" }, { "name": "login", "in": "query", "schema": { "type": "string" }, "descriptionHTML": "Limits the list of credentials authorizations for an organization to a specific login
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "login": "octocat", "credential_id": 161195, "credential_type": "personal access token", "token_last_eight": "71c3fc11", "credential_authorized_at": "2011-01-26T19:06:43Z", "authorized_credential_expires_at": "2011-02-25T19:06:43Z", "scopes": [ "user", "repo" ] }, { "login": "hubot", "credential_id": 161196, "credential_type": "personal access token", "token_last_eight": "Ae178B4a", "credential_authorized_at": "2019-03-29T19:06:43Z", "authorized_credential_expires_at": "2019-04-28T19:06:43Z", "scopes": [ "repo" ] } ] } } ], "previews": [], "descriptionHTML": "Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see GitHub's products.
\nAn authenticated organization owner with the read:org scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.
OK
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/credential-authorizations/{credential_id}", "title": "Remove a SAML SSO authorization for an organization", "category": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "credential_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "credential_id": "CREDENTIAL_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see GitHub's products.
\nAn authenticated organization owner with the admin:org scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.
No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/installations", "title": "List app installations for an organization", "category": "orgs", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "installations": [ { "id": 25381, "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 }, "repository_selection": "selected", "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", "app_id": 2218, "target_id": 6811672, "target_type": "Organization", "permissions": { "deployments": "write", "metadata": "read", "pull_requests": "read", "statuses": "read" }, "events": [ "deployment", "deployment_status" ], "created_at": "2017-05-16T08:47:09.000-07:00", "updated_at": "2017-06-06T11:23:23.000-07:00", "single_file_name": "config.yml", "has_multiple_single_files": true, "single_file_paths": [ "config.yml", ".github/issue_TEMPLATE.md" ], "app_slug": "github-actions", "suspended_at": null, "suspended_by": null } ] } } } ], "previews": [], "descriptionHTML": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
OK
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/orgs", "title": "List organizations for the authenticated user", "category": "orgs", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" } ] } } ], "previews": [], "descriptionHTML": "List organizations for the authenticated user.
\nOAuth scope requirements
\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "orgs" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/orgs", "title": "List organizations for a user", "category": "orgs", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" } ] } } ], "previews": [], "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "orgs" } ], "blocking": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/blocks", "title": "List users blocked by an organization", "category": "orgs", "subcategory": "blocking", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "List the users blocked by an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/blocks/{username}", "title": "Check if a user is blocked by an organization", "category": "orgs", "subcategory": "blocking", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "If the user is blocked:
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "If the user is blocked:
" }, { "httpStatusCode": "404", "description": "If the user is not blocked:
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/blocks/{username}", "title": "Block a user from an organization", "category": "orgs", "subcategory": "blocking", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/blocks/{username}", "title": "Unblock a user from an organization", "category": "orgs", "subcategory": "blocking", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "custom-roles": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/organizations/{organization_id}/custom_roles", "title": "List custom repository roles in an organization", "category": "orgs", "subcategory": "custom-roles", "parameters": [ { "name": "organization_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "organization_id": "ORGANIZATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response - list of custom role names
", "example": { "total_count": 2, "custom_roles": [ { "id": 8030, "name": "Developer" }, { "id": 8031, "name": "Designer" } ] } } } ], "previews": [], "descriptionHTML": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.
\nFor more information on custom repository roles, see \"Managing custom repository roles for an organization\".
", "statusCodes": [ { "httpStatusCode": "200", "description": "Response - list of custom role names
" } ] } ], "members": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/failed_invitations", "title": "List failed organization invitations", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } ] } } ], "previews": [], "descriptionHTML": "The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/invitations", "title": "List pending organization invitations", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } ] } } ], "previews": [], "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/invitations", "title": "Create an organization invitation", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "integer", "description": "Required unless you provide email. GitHub user ID for the person you are inviting.
Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.
Specify role for new member. Can be one of:
\n* admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
\n* direct_member - Non-owner organization members with ability to see other members and join teams by invitation.
\n* billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.
Specify IDs for the teams you want to invite new members to.
", "items": { "type": "integer" }, "name": "team_ids", "in": "body", "rawType": "array", "rawDescription": "Specify IDs for the teams you want to invite new members to.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "email": "octocat@github.com", "role": "direct_member", "team_ids": [ 12, 26 ] }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } } } ], "previews": [], "descriptionHTML": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/invitations/{invitation_id}", "title": "Cancel an organization invitation", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "invitation_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
\nThis endpoint triggers notifications.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/invitations/{invitation_id}/teams", "title": "List organization invitation teams", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "invitation_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "invitation_id": "INVITATION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ] } } ], "previews": [], "descriptionHTML": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/members", "title": "List organization members", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", "all" ], "default": "all" }, "descriptionHTML": "Filter members returned in the list. Can be one of:
\n* 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.
\n* all - All members the authenticated user can see.
Filter members returned by their role. Can be one of:
\n* all - All members of the organization, regardless of role.
\n* admin - Organization owners.
\n* member - Non-owner organization members.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "302", "description": "Response if requester is not an organization member
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/members/{username}", "title": "Check organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response if requester is an organization member and user is a member
" } } ], "previews": [], "descriptionHTML": "Check if a user is, publicly or privately, a member of the organization.
", "statusCodes": [ { "httpStatusCode": "204", "description": "Response if requester is an organization member and user is a member
" }, { "httpStatusCode": "302", "description": "Response if requester is not an organization member
" }, { "httpStatusCode": "404", "description": "Not Found if requester is an organization member and user is not a member
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/members/{username}", "title": "Remove an organization member", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/memberships/{username}", "title": "Get organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if user has an active admin membership with organization
", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "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 } } } } ], "previews": [], "descriptionHTML": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.
OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/memberships/{username}", "title": "Set organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The role to give the user in the organization. Can be one of:
\n* admin - The user will become an owner of the organization.
\n* member - The user will become a non-owner member of the organization.
Response if user has an active admin membership with organization
", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "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 } } } } ], "previews": [], "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\n- \n
- If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be
pendinguntil they accept the invitation. \n - Authenticated users can update a user's membership by passing the
roleparameter. If the authenticated user changes a member's role toadmin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role tomember, no email will be sent. \n
Rate limits
\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/memberships/{username}", "title": "Remove organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/public_members", "title": "List public organization members", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Members of an organization can choose to have their membership publicized or not.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/public_members/{username}", "title": "Check public organization membership for a user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response if user is a public member
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "Response if user is a public member
" }, { "httpStatusCode": "404", "description": "Not Found if user is not a public member
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/public_members/{username}", "title": "Set public organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/public_members/{username}", "title": "Remove public organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/memberships/orgs", "title": "List organization memberships for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "pending" ] }, "descriptionHTML": "Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "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 } }, { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", "role": "admin", "organization_url": "https://api.github.com/orgs/invitocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "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 } } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/memberships/orgs/{org}", "title": "Get an organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", "state": "pending", "role": "admin", "organization_url": "https://api.github.com/orgs/invitocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "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 } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user/memberships/orgs/{org}", "title": "Update an organization membership for the authenticated user", "category": "orgs", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The state that the membership should be in. Only \"active\" will be accepted.
Response
", "example": { "url": "https://api.github.com/orgs/octocat/memberships/defunkt", "state": "active", "role": "admin", "organization_url": "https://api.github.com/orgs/octocat", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization" }, "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 } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "outside-collaborators": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/outside_collaborators", "title": "List outside collaborators for an organization", "category": "orgs", "subcategory": "outside-collaborators", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "2fa_disabled", "all" ], "default": "all" }, "descriptionHTML": "Filter the list of outside collaborators. Can be one of:
\n* 2fa_disabled: Outside collaborators without two-factor authentication enabled.
\n* all: All outside collaborators.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "List all users who are outside collaborators of an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/outside_collaborators/{username}", "title": "Convert an organization member to outside collaborator", "category": "orgs", "subcategory": "outside-collaborators", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "202", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "202", "description": "User is getting converted asynchronously
" } }, { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "User was converted
" } } ], "previews": [], "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "statusCodes": [ { "httpStatusCode": "202", "description": "User is getting converted asynchronously
" }, { "httpStatusCode": "204", "description": "User was converted
" }, { "httpStatusCode": "403", "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}", "title": "Remove outside collaborator from an organization", "category": "orgs", "subcategory": "outside-collaborators", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if user is a member of the organization
" } ] } ], "webhooks": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks", "title": "List organization webhooks", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/hooks", "title": "Create an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. Must be passed as \"web\".
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "Must be passed as \"web\".", "childParamsGroups": [] }, { "type": "object", "description": "Required. Key/value pairs to provide settings for this webhook. These are defined below.
", "properties": { "url": { "type": "string", "description": "Required. The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Required. The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Determines what events the hook is triggered for.
", "default": [ "push" ], "items": { "type": "string" }, "name": "events", "in": "body", "rawType": "array", "rawDescription": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", "childParamsGroups": [] }, { "type": "boolean", "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" } } } ], "previews": [], "descriptionHTML": "Here's how you can create a hook that posts payloads in JSON format:
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}", "title": "Get an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", "name": "web", "events": [ "push", "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" } } } ], "previews": [], "descriptionHTML": "Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}", "title": "Update an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "object", "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "properties": { "url": { "type": "string", "description": "Required. The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Required. The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Determines what events the hook is triggered for.
", "default": [ "push" ], "items": { "type": "string" }, "name": "events", "in": "body", "rawType": "array", "rawDescription": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", "childParamsGroups": [] }, { "type": "boolean", "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", "example": { "id": 1, "url": "https://api.github.com/orgs/octocat/hooks/1", "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "name": "web", "events": [ "pull_request" ], "active": true, "config": { "url": "http://example.com", "content_type": "json" }, "updated_at": "2011-09-06T20:39:23Z", "created_at": "2011-09-06T17:26:27Z", "type": "Organization" } } } ], "previews": [], "descriptionHTML": "Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/hooks/{hook_id}", "title": "Delete an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}/config", "title": "Get a webhook configuration for an organization", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } ], "previews": [], "descriptionHTML": "Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/hooks/{hook_id}/config", "title": "Update a webhook configuration for an organization", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } ], "previews": [], "descriptionHTML": "Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries", "title": "List deliveries for an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "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.
Response
", "example": [ { "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 }, { "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 } ] } } ], "previews": [], "descriptionHTML": "Returns a list of webhook deliveries for a webhook configured in an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", "title": "Get a webhook delivery for an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID", "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "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" } } } } ], "previews": [], "descriptionHTML": "Returns a delivery for a webhook configured in an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", "title": "Redeliver a delivery for an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID", "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "previews": [], "descriptionHTML": "Redeliver a delivery for a webhook configured in an organization.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", "title": "Ping an organization webhook", "category": "orgs", "subcategory": "webhooks", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "packages": { "packages": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/packages", "title": "List packages for an organization", "category": "packages", "parameters": [ { "name": "package_type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The selected visibility of the packages. Can be one of public, private, or internal. Only container package_types currently support internal visibility properly. For other ecosystems internal is synonymous with private. This parameter is optional and only filters an existing result set.
Response
", "example": [ { "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" } ] } } ], "previews": [], "descriptionHTML": "Lists all packages in an organization readable by the user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}", "title": "Get a package for an organization", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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" } } } ], "previews": [], "descriptionHTML": "Gets a specific package in an organization.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}", "title": "Delete a package for an organization", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container you want to delete. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/restore", "title": "Restore a package for an organization", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "token", "schema": { "type": "string" }, "required": false, "in": "query", "descriptionHTML": "package token
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores an entire package in an organization.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:write scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container that you want to restore. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions", "title": "Get all package versions for a package owned by an organization", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "deleted" ], "default": "active" }, "descriptionHTML": "The state of the package, either active or deleted.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 245301, "name": "1.0.4", "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301", "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", "created_at": "2019-11-05T22:49:04Z", "updated_at": "2019-11-05T22:49:04Z", "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4", "metadata": { "package_type": "npm" } }, { "id": 209672, "name": "1.0.3", "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672", "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", "created_at": "2019-10-29T15:42:11Z", "updated_at": "2019-10-29T15:42:12Z", "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3", "metadata": { "package_type": "npm" } } ] } } ], "previews": [], "descriptionHTML": "Returns all package versions for a package owned by an organization.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Get a package version for an organization", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 836, "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836", "package_html_url": "https://github.com/orgs/github/packages/container/package/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/hello_docker/836", "metadata": { "package_type": "container", "container": { "tags": [ "latest" ] } } } } } ], "previews": [], "descriptionHTML": "Gets a specific package version in an organization.
\nYou must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Delete package version for an organization", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container you want to delete. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "title": "Restore package version for an organization", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "org": "ORG", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores a specific package version in an organization.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:write scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container that you want to restore. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/packages", "title": "List packages for the authenticated user's namespace", "category": "packages", "parameters": [ { "name": "package_type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The selected visibility of the packages. Can be one of public, private, or internal. Only container package_types currently support internal visibility properly. For other ecosystems internal is synonymous with private. This parameter is optional and only filters an existing result set.
Response
", "example": [ { "id": 197, "name": "hello_docker", "package_type": "container", "owner": { "login": "monalisa", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.monalisausercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "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": "User", "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/monalisa", "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": "User", "site_admin": false }, "version_count": 2, "visibility": "private", "url": "https://api.github.com/user/monalisa/packages/container/goodbye_docker", "created_at": "2020-05-20T22:19:11Z", "updated_at": "2020-05-20T22:19:11Z", "html_url": "https://github.com/user/monalisa/packages/container/package/goodbye_docker" } ] } } ], "previews": [], "descriptionHTML": "Lists packages owned by the authenticated user within the user's namespace.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/packages/{package_type}/{package_name}", "title": "Get a package for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 40201, "name": "octo-name", "package_type": "rubygems", "owner": { "login": "octocat", "id": 209477, "node_id": "MDQ6VXNlcjIwOTQ3Nw==", "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", "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": true }, "version_count": 3, "visibility": "public", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name", "created_at": "2019-10-20T14:17:14Z", "updated_at": "2019-10-20T14:17:14Z", "repository": { "id": 216219492, "node_id": "MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=", "name": "octo-name-repo", "full_name": "octocat/octo-name-repo", "private": false, "owner": { "login": "octocat", "id": 209477, "node_id": "MDQ6VXNlcjIwOTQ3Nw==", "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", "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": true }, "html_url": "https://github.com/octocat/octo-name-repo", "description": "Project for octocats", "fork": false, "url": "https://api.github.com/repos/octocat/octo-name-repo", "forks_url": "https://api.github.com/repos/octocat/octo-name-repo/forks", "keys_url": "https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octocat/octo-name-repo/teams", "hooks_url": "https://api.github.com/repos/octocat/octo-name-repo/hooks", "issue_events_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}", "events_url": "https://api.github.com/repos/octocat/octo-name-repo/events", "assignees_url": "https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}", "branches_url": "https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}", "tags_url": "https://api.github.com/repos/octocat/octo-name-repo/tags", "blobs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}", "languages_url": "https://api.github.com/repos/octocat/octo-name-repo/languages", "stargazers_url": "https://api.github.com/repos/octocat/octo-name-repo/stargazers", "contributors_url": "https://api.github.com/repos/octocat/octo-name-repo/contributors", "subscribers_url": "https://api.github.com/repos/octocat/octo-name-repo/subscribers", "subscription_url": "https://api.github.com/repos/octocat/octo-name-repo/subscription", "commits_url": "https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octocat/octo-name-repo/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}", "compare_url": "https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octocat/octo-name-repo/merges", "archive_url": "https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octocat/octo-name-repo/downloads", "issues_url": "https://api.github.com/repos/octocat/octo-name-repo/issues{/number}", "pulls_url": "https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}", "milestones_url": "https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octocat/octo-name-repo/labels{/name}", "releases_url": "https://api.github.com/repos/octocat/octo-name-repo/releases{/id}", "deployments_url": "https://api.github.com/repos/octocat/octo-name-repo/deployments" }, "html_url": "https://github.com/octocat/octo-name-repo/packages/40201" } } } ], "previews": [], "descriptionHTML": "Gets a specific package for a package owned by the authenticated user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/packages/{package_type}/{package_name}", "title": "Delete a package for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes.\nIf package_type is not container, your token must also include the repo scope.
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/packages/{package_type}/{package_name}/restore", "title": "Restore a package for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "token", "schema": { "type": "string" }, "required": false, "in": "query", "descriptionHTML": "package token
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores a package owned by the authenticated user.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. If package_type is not container, your token must also include the repo scope.
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/packages/{package_type}/{package_name}/versions", "title": "Get all package versions for a package owned by the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "deleted" ], "default": "active" }, "descriptionHTML": "The state of the package, either active or deleted.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 45763, "name": "sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9", "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763", "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", "created_at": "2020-09-11T21:56:40Z", "updated_at": "2021-02-05T21:32:32Z", "html_url": "https://github.com/users/octocat/packages/container/hello_docker/45763", "metadata": { "package_type": "container", "container": { "tags": [ "latest" ] } } }, { "id": 881, "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/881", "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", "created_at": "2020-05-21T22:22:20Z", "updated_at": "2021-02-05T21:32:32Z", "html_url": "https://github.com/users/octocat/packages/container/hello_docker/881", "metadata": { "package_type": "container", "container": { "tags": [] } } } ] } } ], "previews": [], "descriptionHTML": "Returns all package versions for a package owned by the authenticated user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Get a package version for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 214, "name": "sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a", "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/214", "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", "created_at": "2020-05-15T03:46:45Z", "updated_at": "2020-05-15T03:46:45Z", "html_url": "https://github.com/users/octocat/packages/container/hello_docker/214", "metadata": { "package_type": "container", "container": { "tags": [ "1.13.6" ] } } } } } ], "previews": [], "descriptionHTML": "Gets a specific package version for a package owned by the authenticated user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Delete a package version for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the packages:read and packages:delete scopes.\nIf package_type is not container, your token must also include the repo scope.
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "title": "Restore a package version for the authenticated user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores a package version owned by the authenticated user.
\nYou can restore a deleted package version under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. If package_type is not container, your token must also include the repo scope.
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/packages", "title": "List packages for a user", "category": "packages", "parameters": [ { "name": "package_type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The selected visibility of the packages. Can be one of public, private, or internal. Only container package_types currently support internal visibility properly. For other ecosystems internal is synonymous with private. This parameter is optional and only filters an existing result set.
Response
", "example": [ { "id": 197, "name": "hello_docker", "package_type": "container", "owner": { "login": "monalisa", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", "avatar_url": "https://avatars.monalisausercontent.com/u/9919?v=4", "gravatar_id": "", "url": "https://api.github.com/users/monalisa", "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": "User", "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/monalisa", "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": "User", "site_admin": false }, "version_count": 2, "visibility": "private", "url": "https://api.github.com/user/monalisa/packages/container/goodbye_docker", "created_at": "2020-05-20T22:19:11Z", "updated_at": "2020-05-20T22:19:11Z", "html_url": "https://github.com/user/monalisa/packages/container/package/goodbye_docker" } ] } } ], "previews": [], "descriptionHTML": "Lists all packages in a user's namespace for which the requesting user has access.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/packages/{package_type}/{package_name}", "title": "Get a package for a user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 40201, "name": "octo-name", "package_type": "rubygems", "owner": { "login": "octocat", "id": 209477, "node_id": "MDQ6VXNlcjIwOTQ3Nw==", "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", "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": true }, "version_count": 3, "visibility": "public", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name", "created_at": "2019-10-20T14:17:14Z", "updated_at": "2019-10-20T14:17:14Z", "repository": { "id": 216219492, "node_id": "MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=", "name": "octo-name-repo", "full_name": "octocat/octo-name-repo", "private": false, "owner": { "login": "octocat", "id": 209477, "node_id": "MDQ6VXNlcjIwOTQ3Nw==", "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", "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": true }, "html_url": "https://github.com/octocat/octo-name-repo", "description": "Project for octocats", "fork": false, "url": "https://api.github.com/repos/octocat/octo-name-repo", "forks_url": "https://api.github.com/repos/octocat/octo-name-repo/forks", "keys_url": "https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octocat/octo-name-repo/teams", "hooks_url": "https://api.github.com/repos/octocat/octo-name-repo/hooks", "issue_events_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}", "events_url": "https://api.github.com/repos/octocat/octo-name-repo/events", "assignees_url": "https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}", "branches_url": "https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}", "tags_url": "https://api.github.com/repos/octocat/octo-name-repo/tags", "blobs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}", "languages_url": "https://api.github.com/repos/octocat/octo-name-repo/languages", "stargazers_url": "https://api.github.com/repos/octocat/octo-name-repo/stargazers", "contributors_url": "https://api.github.com/repos/octocat/octo-name-repo/contributors", "subscribers_url": "https://api.github.com/repos/octocat/octo-name-repo/subscribers", "subscription_url": "https://api.github.com/repos/octocat/octo-name-repo/subscription", "commits_url": "https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octocat/octo-name-repo/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}", "compare_url": "https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octocat/octo-name-repo/merges", "archive_url": "https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octocat/octo-name-repo/downloads", "issues_url": "https://api.github.com/repos/octocat/octo-name-repo/issues{/number}", "pulls_url": "https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}", "milestones_url": "https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octocat/octo-name-repo/labels{/name}", "releases_url": "https://api.github.com/repos/octocat/octo-name-repo/releases{/id}", "deployments_url": "https://api.github.com/repos/octocat/octo-name-repo/deployments" }, "html_url": "https://github.com/octocat/octo-name-repo/packages/40201" } } } ], "previews": [], "descriptionHTML": "Gets a specific package metadata for a public package owned by a user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/users/{username}/packages/{package_type}/{package_name}", "title": "Delete a package for a user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container you want to delete. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/restore", "title": "Restore a package for a user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "token", "schema": { "type": "string" }, "required": false, "in": "query", "descriptionHTML": "package token
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores an entire package for a user.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container that you want to restore. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions", "title": "Get all package versions for a package owned by a user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 3497268, "name": "0.3.0", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/3497268", "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", "license": "MIT", "created_at": "2020-08-31T15:22:11Z", "updated_at": "2020-08-31T15:22:12Z", "description": "Project for octocats", "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.3.0", "metadata": { "package_type": "rubygems" } }, { "id": 387039, "name": "0.2.0", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039", "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", "license": "MIT", "created_at": "2019-12-01T20:49:29Z", "updated_at": "2019-12-01T20:49:30Z", "description": "Project for octocats", "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0", "metadata": { "package_type": "rubygems" } }, { "id": 169770, "name": "0.1.0", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/169770", "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", "license": "MIT", "created_at": "2019-10-20T14:17:14Z", "updated_at": "2019-10-20T14:17:15Z", "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.1.0", "metadata": { "package_type": "rubygems" } } ] } } ], "previews": [], "descriptionHTML": "Returns all package versions for a public package owned by a specified user.
\nTo use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Get a package version for a user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "package_version_id": "PACKAGE_VERSION_ID", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 387039, "name": "0.2.0", "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039", "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", "license": "MIT", "created_at": "2019-12-01T20:49:29Z", "updated_at": "2019-12-01T20:49:30Z", "description": "Octo-name client for Ruby", "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0", "metadata": { "package_type": "rubygems" } } } } ], "previews": [], "descriptionHTML": "Gets a specific package version for a public package owned by a specified user.
\nAt this time, to use this endpoint, you must authenticate using an access token with the packages:read scope.\nIf package_type is not container, your token must also include the repo scope.
OK
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "title": "Delete package version for a user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nTo use this endpoint, you must authenticate using an access token with the packages:read and packages:delete scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container you want to delete. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "title": "Restore package version for a user", "category": "packages", "parameters": [ { "name": "package_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "npm", "maven", "rubygems", "docker", "nuget", "container" ] }, "descriptionHTML": "The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub's Gradle registry have the type maven. Docker images pushed to GitHub's Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub's Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The name of the package.
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "package_version_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "Unique identifier of the package version.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "package_type": "PACKAGE_TYPE", "package_name": "PACKAGE_NAME", "username": "USERNAME", "package_version_id": "PACKAGE_VERSION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Restores a specific package version for a user.
\nYou can restore a deleted package under the following conditions:
\n- \n
- The package was deleted within the last 30 days. \n
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. \n
To use this endpoint, you must authenticate using an access token with the packages:read and packages:write scopes. In addition:
- \n
- If
package_typeis notcontainer, your token must also include thereposcope. \n - If
package_typeiscontainer, you must also have admin permissions to the container that you want to restore. \n
No Content
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "packages" } ] }, "pages": { "pages": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages", "title": "Get a GitHub Pages site", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", "cname": "developer.github.com", "custom_404": false, "html_url": "https://developer.github.com", "source": { "branch": "master", "path": "/" }, "public": true, "https_certificate": { "state": "approved", "description": "Certificate is approved", "domains": [ "developer.github.com" ], "expires_at": "2021-05-22" }, "https_enforced": true } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages", "title": "Create a GitHub Pages site", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "object", "description": "Required. The source branch and directory used to publish your Pages site.
", "properties": { "branch": { "type": "string", "description": "Required. The repository branch used to publish your site's source files.
", "name": "branch", "in": "body", "rawType": "string", "rawDescription": "The repository branch used to publish your site's source files.", "childParamsGroups": [] }, "path": { "type": "string", "description": "The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /
Required. The repository branch used to publish your site's source files.
", "name": "branch", "in": "body", "rawType": "string", "rawDescription": "The repository branch used to publish your site's source files.", "childParamsGroups": [] }, { "type": "string", "description": "The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /
Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages", "status": "built", "cname": "developer.github.com", "custom_404": false, "html_url": "https://developer.github.com", "source": { "branch": "master", "path": "/" }, "public": true, "https_certificate": { "state": "approved", "description": "Certificate is approved", "domains": [ "developer.github.com" ], "expires_at": "2021-05-22" }, "https_enforced": true } } } ], "previews": [], "descriptionHTML": "Configures a GitHub Pages site. For more information, see \"About GitHub Pages.\"
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pages", "title": "Update information about a GitHub Pages site", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string or null", "description": "Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"
Specify whether HTTPS should be enforced for the repository.
", "name": "https_enforced", "in": "body", "rawType": "boolean", "rawDescription": "Specify whether HTTPS should be enforced for the repository.", "childParamsGroups": [] }, { "type": "boolean", "description": "Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.
Response
" } } ], "previews": [], "descriptionHTML": "Updates information for a GitHub Pages site. For more information, see \"About GitHub Pages.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pages", "title": "Delete a GitHub Pages site", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds", "title": "List GitHub Pages builds", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", "error": { "message": null }, "pusher": { "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 }, "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", "duration": 2104, "created_at": "2014-02-10T19:00:49Z", "updated_at": "2014-02-10T19:00:51Z" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pages/builds", "title": "Request a GitHub Pages build", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", "status": "queued" } } } ], "previews": [], "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/latest", "title": "Get latest Pages build", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", "error": { "message": null }, "pusher": { "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 }, "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", "duration": 2104, "created_at": "2014-02-10T19:00:49Z", "updated_at": "2014-02-10T19:00:51Z" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}", "title": "Get GitHub Pages build", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "build_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "build_id": "BUILD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", "status": "built", "error": { "message": null }, "pusher": { "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 }, "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", "duration": 2104, "created_at": "2014-02-10T19:00:49Z", "updated_at": "2014-02-10T19:00:51Z" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "pages" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/health", "title": "Get a DNS health check for GitHub Pages", "category": "pages", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "domain": { "host": "example.com", "uri": "http://example.com/", "nameservers": "default", "dns_resolves": true, "is_proxied": false, "is_cloudflare_ip": false, "is_fastly_ip": false, "is_old_ip_address": false, "is_a_record": true, "has_cname_record": false, "has_mx_records_present": false, "is_valid_domain": true, "is_apex_domain": true, "should_be_a_record": true, "is_cname_to_github_user_domain": false, "is_cname_to_pages_dot_github_dot_com": false, "is_cname_to_fastly": false, "is_pointed_to_github_pages_ip": true, "is_non_github_pages_ip_present": false, "is_pages_domain": false, "is_served_by_pages": true, "is_valid": true, "reason": null, "responds_to_https": true, "enforces_https": true, "https_error": null, "is_https_eligible": true, "caa_error": null }, "alt_domain": { "host": "www.example.com", "uri": "http://www.example.com/", "nameservers": "default", "dns_resolves": true, "is_proxied": false, "is_cloudflare_ip": false, "is_fastly_ip": false, "is_old_ip_address": false, "is_a_record": true, "has_cname_record": false, "has_mx_records_present": false, "is_valid_domain": true, "is_apex_domain": true, "should_be_a_record": true, "is_cname_to_github_user_domain": false, "is_cname_to_pages_dot_github_dot_com": false, "is_cname_to_fastly": false, "is_pointed_to_github_pages_ip": true, "is_non_github_pages_ip_present": false, "is_pages_domain": false, "is_served_by_pages": true, "is_valid": true, "reason": null, "responds_to_https": true, "enforces_https": true, "https_error": null, "is_https_eligible": true, "caa_error": null } } } } ], "previews": [], "descriptionHTML": "Gets a health check of the DNS settings for the CNAME record configured for a repository's GitHub Pages.
The first request to this endpoint returns a 202 Accepted status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a 200 OK status with the health check results in the response.
Users must have admin or owner permissions. GitHub Apps must have the pages:write and administration:write permission to use this endpoint.
OK
" }, { "httpStatusCode": "202", "description": "Empty response
" }, { "httpStatusCode": "400", "description": "Custom domains are not available for GitHub Pages
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "There isn't a CNAME for this page
" } ], "subcategory": "pages" } ] }, "projects": { "projects": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/projects", "title": "List organization projects", "category": "projects", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "all" ], "default": "open" }, "descriptionHTML": "Indicates the state of the projects to return. Can be either open, closed, or all.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z" } ] } } ], "previews": [], "descriptionHTML": "Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/projects", "title": "Create an organization project", "category": "projects", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The name of the project.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the project.", "childParamsGroups": [] }, { "type": "string", "description": "The description of the project.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The description of the project.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year." }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z" } } } ], "previews": [], "descriptionHTML": "Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Created
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/{project_id}", "title": "Get a project", "category": "projects", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } } } ], "previews": [], "descriptionHTML": "Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/projects/{project_id}", "title": "Update a project", "category": "projects", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "description": "Name of the project
", "type": "string", "examples": [ "Week One Sprint" ], "name": "name", "in": "body", "rawType": "string", "rawDescription": "Name of the project", "childParamsGroups": [] }, { "description": "Body of the project
", "type": "string or null", "examples": [ "This project represents the sprint of the first week in January" ], "name": "body", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "Body of the project", "childParamsGroups": [] }, { "description": "State of the project; either 'open' or 'closed'
", "type": "string", "examples": [ "open" ], "name": "state", "in": "body", "rawType": "string", "rawDescription": "State of the project; either 'open' or 'closed'", "childParamsGroups": [] }, { "description": "The baseline permission that all organization members have on this project
", "type": "string", "enum": [ "read", "write", "admin", "none" ], "name": "organization_permission", "in": "body", "rawType": "string", "rawDescription": "The baseline permission that all organization members have on this project", "childParamsGroups": [] }, { "description": "Whether or not this project can be seen by everyone.
", "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", "rawDescription": "Whether or not this project can be seen by everyone.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } } } ], "previews": [], "descriptionHTML": "Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found if the authenticated user does not have access to the project
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/projects/{project_id}", "title": "Delete a project", "category": "projects", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", "description": "Delete Success
" } } ], "previews": [], "descriptionHTML": "Deletes a project board. Returns a 404 Not Found status if projects are disabled.
Delete Success
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/projects", "title": "List repository projects", "category": "projects", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "all" ], "default": "open" }, "descriptionHTML": "Indicates the state of the projects to return. Can be either open, closed, or all.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } ] } } ], "previews": [], "descriptionHTML": "Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
OK
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/projects", "title": "Create a repository project", "category": "projects", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The name of the project.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the project.", "childParamsGroups": [] }, { "type": "string", "description": "The description of the project.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The description of the project.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Projects Documentation", "body": "Developer documentation project for the developer site." }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/repos/api-playground/projects-test", "url": "https://api.github.com/projects/1002604", "html_url": "https://github.com/api-playground/projects-test/projects/1", "columns_url": "https://api.github.com/projects/1002604/columns", "id": 1002604, "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", "name": "Projects Documentation", "body": "Developer documentation project for the developer site.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } } } ], "previews": [], "descriptionHTML": "Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
Created
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/projects", "title": "Create a user project", "category": "projects", "parameters": [], "bodyParameters": [ { "description": "Required. Name of the project
", "type": "string", "examples": [ "Week One Sprint" ], "name": "name", "in": "body", "rawType": "string", "rawDescription": "Name of the project", "childParamsGroups": [] }, { "description": "Body of the project
", "type": "string or null", "examples": [ "This project represents the sprint of the first week in January" ], "name": "body", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "Body of the project", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", "html_url": "https://github.com/users/octocat/projects/1", "columns_url": "https://api.github.com/projects/1002603/columns", "id": 1002603, "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", "name": "My Projects", "body": "A board to manage my personal projects.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/projects", "title": "List user projects", "category": "projects", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "all" ], "default": "open" }, "descriptionHTML": "Indicates the state of the projects to return. Can be either open, closed, or all.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/users/octocat", "url": "https://api.github.com/projects/1002603", "html_url": "https://github.com/users/octocat/projects/1", "columns_url": "https://api.github.com/projects/1002603/columns", "id": 1002603, "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", "name": "My Projects", "body": "A board to manage my personal projects.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-10T20:09:31Z", "updated_at": "2014-03-03T18:58:10Z" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "projects" } ], "cards": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/columns/cards/{card_id}", "title": "Get a project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "card_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "card_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "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 }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/projects/columns/cards/{card_id}", "title": "Update an existing project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "card_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "card_id parameter
" } ], "bodyParameters": [ { "description": "The project card's note
", "type": "string or null", "examples": [ "Update all gems" ], "name": "note", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "The project card's note", "childParamsGroups": [] }, { "description": "Whether or not the card is archived
", "type": "boolean", "examples": [ false ], "name": "archived", "in": "body", "rawType": "boolean", "rawDescription": "Whether or not the card is archived", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "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 }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/projects/columns/cards/{card_id}", "title": "Delete a project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "card_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "card_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/projects/columns/cards/{card_id}/moves", "title": "Move a project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "card_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "card_id parameter
" } ], "bodyParameters": [ { "description": "Required. The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.
The unique identifier of the column the card should be moved to
", "type": "integer", "examples": [ 42 ], "name": "column_id", "in": "body", "rawType": "integer", "rawDescription": "The unique identifier of the column the card should be moved to", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "201", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "card_id": "CARD_ID" } }, "response": { "statusCode": "201", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service Unavailable
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/columns/{column_id}/cards", "title": "List project cards", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "column_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "column_id parameter
" }, { "name": "archived_state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "archived", "not_archived" ], "default": "not_archived" }, "descriptionHTML": "Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "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 }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/projects/columns/{column_id}/cards", "title": "Create a project card", "category": "projects", "subcategory": "cards", "parameters": [ { "name": "column_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "column_id parameter
" } ], "bodyParameters": [ { "description": "Required. The project card's note
", "type": "string or null", "examples": [ "Update all gems" ], "name": "note", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "The project card's note", "childParamsGroups": [] }, { "description": "Required. The unique identifier of the content associated with the card
", "type": "integer", "examples": [ 42 ], "name": "content_id", "in": "body", "rawType": "integer", "rawDescription": "The unique identifier of the content associated with the card", "childParamsGroups": [] }, { "description": "Required. The piece of content associated with the card
", "type": "string", "examples": [ "PullRequest" ], "name": "content_type", "in": "body", "rawType": "string", "rawDescription": "The piece of content associated with the card", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/cards/1478", "id": 1478, "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", "note": "Add payload for delete Project column", "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 }, "created_at": "2016-09-05T14:21:06Z", "updated_at": "2016-09-05T14:20:22Z", "archived": false, "column_url": "https://api.github.com/projects/columns/367", "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", "project_url": "https://api.github.com/projects/120" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service Unavailable
" } ] } ], "collaborators": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/{project_id}/collaborators", "title": "List project collaborators", "category": "projects", "subcategory": "collaborators", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "affiliation", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "outside", "direct", "all" ], "default": "all" }, "descriptionHTML": "Filters the collaborators by their affiliation. Can be one of:
\n* outside: Outside collaborators of a project that are not a member of the project's organization.
\n* direct: Collaborators with permissions to a project, regardless of organization membership status.
\n* all: All collaborators the authenticated user can see.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/projects/{project_id}/collaborators/{username}", "title": "Add project collaborator", "category": "projects", "subcategory": "collaborators", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "description": "The permission to grant the collaborator.
", "enum": [ "read", "write", "admin" ], "default": "write", "type": "string", "examples": [ "write" ], "name": "permission", "in": "body", "rawType": "string", "rawDescription": "The permission to grant the collaborator.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/projects/{project_id}/collaborators/{username}", "title": "Remove user as a collaborator", "category": "projects", "subcategory": "collaborators", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/{project_id}/collaborators/{username}/permission", "title": "Get project permission for a user", "category": "projects", "subcategory": "collaborators", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "permission": "admin", "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 } } } } ], "previews": [], "descriptionHTML": "Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "columns": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/columns/{column_id}", "title": "Get a project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "column_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "column_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/projects/columns/{column_id}", "title": "Update an existing project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "column_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "column_id parameter
" } ], "bodyParameters": [ { "description": "Required. Name of the project column
", "type": "string", "examples": [ "Remaining tasks" ], "name": "name", "in": "body", "rawType": "string", "rawDescription": "Name of the project column", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/projects/columns/{column_id}", "title": "Delete a project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "column_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "column_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "column_id": "COLUMN_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/projects/columns/{column_id}/moves", "title": "Move a project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "column_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "column_id parameter
" } ], "bodyParameters": [ { "description": "Required. The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.
Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/projects/{project_id}/columns", "title": "List project columns", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/projects/{project_id}/columns", "title": "Create a project column", "category": "projects", "subcategory": "columns", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "description": "Required. Name of the project column
", "type": "string", "examples": [ "Remaining tasks" ], "name": "name", "in": "body", "rawType": "string", "rawDescription": "Name of the project column", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "project_id": "PROJECT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/projects/columns/367", "project_url": "https://api.github.com/projects/120", "cards_url": "https://api.github.com/projects/columns/367/cards", "id": 367, "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", "name": "To Do", "created_at": "2016-09-05T14:18:44Z", "updated_at": "2016-09-05T14:22:28Z" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "pulls": { "pulls": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls", "title": "List pull requests", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "all" ], "default": "open" }, "descriptionHTML": "Either open, closed, or all to filter by state.
Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.
Filter pulls by base branch name. Example: gh-pages.
What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).
The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "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", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "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 }, "body": "Please pull these awesome changes in!", "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 } ], "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" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "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 }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false } ] } } ], "previews": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls", "title": "Create a pull request", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The title of the new pull request.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "The title of the new pull request.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.
Required. The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
", "name": "base", "in": "body", "rawType": "string", "rawDescription": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", "childParamsGroups": [] }, { "type": "string", "description": "The contents of the pull request.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The contents of the pull request.", "childParamsGroups": [] }, { "type": "boolean", "description": "Indicates whether maintainers can modify the pull request.
", "name": "maintainer_can_modify", "in": "body", "rawType": "boolean", "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "childParamsGroups": [] }, { "type": "boolean", "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
", "name": "draft", "in": "body", "rawType": "boolean", "rawDescription": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", "childParamsGroups": [] }, { "type": "integer", "examples": [ 1 ], "name": "issue", "in": "body", "rawType": "integer", "description": "", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Amazing new feature", "body": "Please pull these awesome changes in!", "head": "octocat:new-feature", "base": "master" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "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", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "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 }, "body": "Please pull these awesome changes in!", "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 } ], "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" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "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 }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "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_merge_commit": true, "allow_forking": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "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_merge_commit": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false, "merged": false, "mergeable": true, "rebaseable": true, "mergeable_state": "clean", "merged_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 }, "comments": 10, "review_comments": 0, "maintainer_can_modify": true, "commits": 3, "additions": 100, "deletions": 3, "changed_files": 5 } } } ], "previews": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
\nYou can create a new pull request.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", "title": "Get a pull request", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Pass the appropriate media type to fetch diff and patch formats.
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "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", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "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 }, "body": "Please pull these awesome changes in!", "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 } ], "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" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "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 }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "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_merge_commit": true, "allow_forking": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "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_merge_commit": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false, "merged": false, "mergeable": true, "rebaseable": true, "mergeable_state": "clean", "merged_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 }, "comments": 10, "review_comments": 0, "maintainer_can_modify": true, "commits": 3, "additions": 100, "deletions": 3, "changed_files": 5 } } } ], "previews": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.
The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:
- \n
- If merged as a merge commit,
merge_commit_sharepresents the SHA of the merge commit. \n - If merged via a squash,
merge_commit_sharepresents the SHA of the squashed commit on the base branch. \n - If rebased,
merge_commit_sharepresents the commit that the base branch was updated to. \n
Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Pass the appropriate media type to fetch diff and patch formats.
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}", "title": "Update a pull request", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The title of the pull request.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "The title of the pull request.", "childParamsGroups": [] }, { "type": "string", "description": "The contents of the pull request.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The contents of the pull request.", "childParamsGroups": [] }, { "type": "string", "description": "State of this Pull Request. Either open or closed.
The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
", "name": "base", "in": "body", "rawType": "string", "rawDescription": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", "childParamsGroups": [] }, { "type": "boolean", "description": "Indicates whether maintainers can modify the pull request.
", "name": "maintainer_can_modify", "in": "body", "rawType": "boolean", "rawDescription": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "new title", "body": "updated body", "state": "open", "base": "master" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "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", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "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 }, "body": "Please pull these awesome changes in!", "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 } ], "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" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "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 }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "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_merge_commit": true, "allow_forking": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "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_merge_commit": true, "forks": 123, "open_issues": 123, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "watchers": 123 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false, "merged": false, "mergeable": true, "rebaseable": true, "mergeable_state": "clean", "merged_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 }, "comments": 10, "review_comments": 0, "maintainer_can_modify": true, "commits": 3, "additions": 100, "deletions": 3, "changed_files": 5 } } } ], "previews": [], "descriptionHTML": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", "title": "List commits on a pull request", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", "commit": { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "author": { "name": "Monalisa Octocat", "email": "support@github.com", "date": "2011-04-14T16:00:49Z" }, "committer": { "name": "Monalisa Octocat", "email": "support@github.com", "date": "2011-04-14T16:00:49Z" }, "message": "Fix all the bugs", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" }, "comment_count": 0, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } }, "author": { "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 }, "committer": { "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 }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" } ] } ] } } ], "previews": [], "descriptionHTML": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/files", "title": "List pull requests files", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", "filename": "file1.txt", "status": "added", "additions": 103, "deletions": 21, "changes": 124, "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" } ] } } ], "previews": [], "descriptionHTML": "Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", "title": "Check if a pull request has been merged", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "204", "description": "Response if pull request has been merged
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "Response if pull request has been merged
" }, { "httpStatusCode": "404", "description": "Not Found if pull request has not been merged
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", "title": "Merge a pull request", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Title for the automatic commit message.
", "name": "commit_title", "in": "body", "rawType": "string", "rawDescription": "Title for the automatic commit message.", "childParamsGroups": [] }, { "type": "string", "description": "Extra detail to append to automatic commit message.
", "name": "commit_message", "in": "body", "rawType": "string", "rawDescription": "Extra detail to append to automatic commit message.", "childParamsGroups": [] }, { "type": "string", "description": "SHA that pull request head must match to allow merge.
", "name": "sha", "in": "body", "rawType": "string", "rawDescription": "SHA that pull request head must match to allow merge.", "childParamsGroups": [] }, { "type": "string", "description": "Merge method to use. Possible values are merge, squash or rebase. Default is merge.
if merge was successful
", "example": { "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "merged": true, "message": "Pull Request successfully merged" } } } ], "previews": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "200", "description": "if merge was successful
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "405", "description": "Method Not Allowed if merge cannot be performed
" }, { "httpStatusCode": "409", "description": "Conflict if sha was provided and pull request head did not match
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", "title": "Update a pull request branch", "category": "pulls", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
Response
", "example": { "message": "Updating pull request branch.", "url": "https://github.com/repos/octocat/Hello-World/pulls/53" } } } ], "previews": [], "descriptionHTML": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "pulls" } ], "comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments", "title": "List review comments in a repository", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated", "created_at" ] }, "descriptionHTML": "" }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "descriptionHTML": "Can be either asc or desc. Ignored without sort parameter.
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "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 }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } ] } } ], "previews": [], "descriptionHTML": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "title": "Get a review comment for a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "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 }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } } } ], "previews": [], "descriptionHTML": "Provides details for a review comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "title": "Update a review comment for a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The text of the reply to the review comment.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The text of the reply to the review comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "I like this too!" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "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 }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } } } ], "previews": [], "descriptionHTML": "Enables you to edit a review comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "title": "Delete a review comment for a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a review comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "title": "List review comments on a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ], "default": "created" }, "descriptionHTML": "One of created (when the repository was starred) or updated (when it was last pushed to).
Can be either asc or desc. Ignored without sort parameter.
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "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 }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } ] } } ], "previews": [], "descriptionHTML": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "title": "Create a review comment for a pull request", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The text of the review comment.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The text of the review comment.", "childParamsGroups": [] }, { "type": "string", "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.
The relative path to the file that necessitates a comment.
", "name": "path", "in": "body", "rawType": "string", "rawDescription": "The relative path to the file that necessitates a comment.", "childParamsGroups": [] }, { "type": "integer", "description": "This paramter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.
The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.
", "name": "line", "in": "body", "rawType": "integer", "rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", "childParamsGroups": [] }, { "type": "integer", "description": "Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.
Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.
The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "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 }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } } } ], "previews": [], "descriptionHTML": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.
The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.
Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "title": "Create a reply for a review comment", "category": "pulls", "subcategory": "comments", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The text of the review comment.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The text of the review comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Great stuff!" }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 426899381, "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 }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } }, "start_line": 1, "original_start_line": 1, "start_side": "RIGHT", "line": 2, "original_line": 2, "side": "RIGHT" } } } ], "previews": [], "descriptionHTML": "Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "review-requests": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "title": "List requested reviewers for a pull request", "category": "pulls", "subcategory": "review-requests", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "users": [ { "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 } ], "teams": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "title": "Request reviewers for a pull request", "category": "pulls", "subcategory": "review-requests", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "array of strings", "description": "An array of user logins that will be requested.
An array of team slugs that will be requested.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", "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", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", "number": 1347, "state": "open", "locked": true, "title": "Amazing new feature", "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 }, "body": "Please pull these awesome changes in!", "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 } ], "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" }, "active_lock_reason": "too heated", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", "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 }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true } ], "requested_reviewers": [ { "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 }, { "login": "hubot", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/hubot", "html_url": "https://github.com/hubot", "followers_url": "https://api.github.com/users/hubot/followers", "following_url": "https://api.github.com/users/hubot/following{/other_user}", "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", "organizations_url": "https://api.github.com/users/hubot/orgs", "repos_url": "https://api.github.com/users/hubot/repos", "events_url": "https://api.github.com/users/hubot/events{/privacy}", "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": true }, { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false } ], "requested_teams": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ], "head": { "label": "octocat:new-topic", "ref": "new-topic", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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 } }, "base": { "label": "octocat:master", "ref": "master", "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "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 }, "repo": { "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } }, "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1347" }, "issue": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, "comments": { "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "review_comments": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" }, "review_comment": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "commits": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" }, "statuses": { "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" } }, "author_association": "OWNER", "auto_merge": null, "draft": false } } } ], "previews": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if user is not a collaborator
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "title": "Remove requested reviewers from a pull request", "category": "pulls", "subcategory": "review-requests", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. An array of user logins that will be removed.
An array of team slugs that will be removed.
Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "reviews": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "title": "List reviews for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "The list of reviews returns in chronological order.
", "example": [ { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "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 }, "body": "Here is the body for the review.", "state": "APPROVED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" } ] } } ], "previews": [], "descriptionHTML": "The list of reviews returns in chronological order.
", "statusCodes": [ { "httpStatusCode": "200", "description": "The list of reviews returns in chronological order.
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "title": "Create a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.
Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
Use the following table to specify the location, destination, and contents of the draft review comment.
", "items": { "type": "object", "properties": { "path": { "type": "string", "description": "Required. The relative path to the file that necessitates a review comment.
", "name": "path", "in": "body", "rawType": "string", "rawDescription": "The relative path to the file that necessitates a review comment.", "childParamsGroups": [] }, "position": { "type": "integer", "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.
", "name": "position", "in": "body", "rawType": "integer", "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", "childParamsGroups": [] }, "body": { "type": "string", "description": "Required. Text of the review comment.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "Text of the review comment.", "childParamsGroups": [] }, "line": { "type": "integer", "examples": [ 28 ], "name": "line", "in": "body", "rawType": "integer", "description": "", "childParamsGroups": [] }, "side": { "type": "string", "examples": [ "RIGHT" ], "name": "side", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, "start_line": { "type": "integer", "examples": [ 26 ], "name": "start_line", "in": "body", "rawType": "integer", "description": "", "childParamsGroups": [] }, "start_side": { "type": "string", "examples": [ "LEFT" ], "name": "start_side", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } }, "required": [ "path", "body" ] }, "name": "comments", "in": "body", "rawType": "array", "rawDescription": "Use the following table to specify the location, destination, and contents of the draft review comment.", "childParamsGroups": [ { "parentName": "comments", "parentType": "items", "id": "comments-items", "params": [ { "type": "string", "description": "Required. The relative path to the file that necessitates a review comment.
", "name": "path", "in": "body", "rawType": "string", "rawDescription": "The relative path to the file that necessitates a review comment.", "childParamsGroups": [] }, { "type": "integer", "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.
", "name": "position", "in": "body", "rawType": "integer", "rawDescription": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", "childParamsGroups": [] }, { "type": "string", "description": "Required. Text of the review comment.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "Text of the review comment.", "childParamsGroups": [] }, { "type": "integer", "examples": [ 28 ], "name": "line", "in": "body", "rawType": "integer", "description": "", "childParamsGroups": [] }, { "type": "string", "examples": [ "RIGHT" ], "name": "side", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, { "type": "integer", "examples": [ 26 ], "name": "start_line", "in": "body", "rawType": "integer", "description": "", "childParamsGroups": [] }, { "type": "string", "examples": [ "LEFT" ], "name": "start_side", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "body": "This is close to perfect! Please address the suggested inline change.", "event": "REQUEST_CHANGES", "comments": [ { "path": "file.md", "position": 6, "body": "Please add more information here, and fix this typo." } ] }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "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 }, "body": "This is close to perfect! Please address the suggested inline change.", "state": "CHANGES_REQUESTED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nPull request reviews created in the PENDING state do not include the submitted_at property in the response.
Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.
The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "title": "Get a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "review_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "review_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "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 }, "body": "Here is the body for the review.", "state": "APPROVED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "title": "Update a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "review_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "review_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The body text of the pull request review.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The body text of the pull request review.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "This is close to perfect! Please address the suggested inline change. And add more about this." }, "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "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 }, "body": "This is close to perfect! Please address the suggested inline change. And add more about this.", "state": "CHANGES_REQUESTED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "Update the review summary comment with new text.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "title": "Delete a pending review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "review_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "review_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "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 }, "body": "This is close to perfect! Please address the suggested inline change.", "state": "CHANGES_REQUESTED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", "title": "List comments for a pull request review", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "review_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "review_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "pull_request_review_id": 42, "id": 10, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "path": "file1.txt", "position": 1, "original_position": 4, "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "in_reply_to_id": 8, "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 }, "body": "Great stuff!", "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "author_association": "NONE", "_links": { "self": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" }, "html": { "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" } } } ] } } ], "previews": [], "descriptionHTML": "List comments for a specific pull request review.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", "title": "Dismiss a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "review_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "review_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The message for the pull request review dismissal
", "name": "message", "in": "body", "rawType": "string", "rawDescription": "The message for the pull request review dismissal", "childParamsGroups": [] }, { "type": "string", "examples": [ "\"APPROVE\"" ], "name": "event", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "pull_number": "PULL_NUMBER", "review_id": "REVIEW_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "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 }, "body": "Here is the body for the review.", "state": "DISMISSED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" } } } ], "previews": [], "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", "title": "Submit a review for a pull request", "category": "pulls", "subcategory": "reviews", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "pull_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "review_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "review_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "The body text of the pull request review
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The body text of the pull request review", "childParamsGroups": [] }, { "type": "string", "description": "Required. The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.
Response
", "example": { "id": 80, "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", "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 }, "body": "Here is the body for the review.", "state": "APPROVED", "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", "_links": { "html": { "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" }, "pull_request": { "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" } }, "submitted_at": "2019-11-17T17:43:43Z", "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", "author_association": "COLLABORATOR" } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "rate-limit": { "rate-limit": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/rate_limit", "title": "Get rate limit status for the authenticated user", "category": "rate-limit", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "resources": { "core": { "limit": 5000, "remaining": 4999, "reset": 1372700873, "used": 1 }, "search": { "limit": 30, "remaining": 18, "reset": 1372697452, "used": 12 }, "graphql": { "limit": 5000, "remaining": 4993, "reset": 1372700389, "used": 7 }, "integration_manifest": { "limit": 5000, "remaining": 4999, "reset": 1551806725, "used": 1 }, "code_scanning_upload": { "limit": 500, "remaining": 499, "reset": 1551806725, "used": 1 } }, "rate": { "limit": 5000, "remaining": 4999, "reset": 1372700873, "used": 1 } } } } ], "previews": [], "descriptionHTML": "Note: Accessing this endpoint does not count against your REST API rate limit.
\nNote: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "rate-limit" } ] }, "reactions": { "reactions": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "title": "List reactions for a team discussion comment", "category": "reactions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
OK
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "title": "Create reaction for a team discussion comment", "category": "reactions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the team discussion comment.
", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response when the reaction type has already been added to this team discussion comment
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
Response when the reaction type has already been added to this team discussion comment
" }, { "httpStatusCode": "201", "description": "Created
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "title": "Delete team discussion comment reaction", "category": "reactions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "reaction_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "title": "List reactions for a team discussion", "category": "reactions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OK
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "title": "Create reaction for a team discussion", "category": "reactions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the team discussion.
", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
OK
" }, { "httpStatusCode": "201", "description": "Created
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "title": "Delete team discussion reaction", "category": "reactions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "reaction_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "title": "List reactions for a commit comment", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "title": "Create reaction for a commit comment", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the commit comment.
", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Reaction exists
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Reaction created
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
Reaction exists
" }, { "httpStatusCode": "201", "description": "Reaction created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", "title": "Delete a commit comment reaction", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" }, { "name": "reaction_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "title": "List reactions for an issue comment", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "title": "Create reaction for an issue comment", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the issue comment.
", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Reaction exists
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Reaction created
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
Reaction exists
" }, { "httpStatusCode": "201", "description": "Reaction created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", "title": "Delete an issue comment reaction", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" }, { "name": "reaction_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to an issue comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", "title": "List reactions for an issue", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "410", "description": "Gone
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", "title": "Create reaction for an issue", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the issue.
", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
OK
" }, { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "title": "Delete an issue reaction", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "issue_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "issue_number parameter
" }, { "name": "reaction_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "issue_number": "ISSUE_NUMBER", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "title": "List reactions for a pull request review comment", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "title": "Create reaction for a pull request review comment", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the pull request review comment.
", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Reaction exists
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Reaction created
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
Reaction exists
" }, { "httpStatusCode": "201", "description": "Reaction created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", "title": "Delete a pull request comment reaction", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "comment_id parameter
" }, { "name": "reaction_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "comment_id": "COMMENT_ID", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions", "title": "List reactions for a release", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "release_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "release_id parameter
" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "laugh", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions", "title": "Create reaction for a release", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "release_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "release_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the release.
", "enum": [ "+1", "laugh", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Reaction exists
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Reaction created
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Reaction exists
" }, { "httpStatusCode": "201", "description": "Reaction created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", "title": "Delete a release reaction", "category": "reactions", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "release_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "release_id parameter
" }, { "name": "reaction_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID", "reaction_id": "REACTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.
Delete a reaction to a release.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "title": "List reactions for a team discussion comment (Legacy)", "category": "reactions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
OK
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "title": "Create reaction for a team discussion comment (Legacy)", "category": "reactions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the team discussion comment.
", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Create reaction for a team discussion comment\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Created
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", "title": "List reactions for a team discussion (Legacy)", "category": "reactions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "content", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ] }, "descriptionHTML": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
OK
" } ], "subcategory": "reactions" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions", "title": "Create reaction for a team discussion (Legacy)", "category": "reactions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The reaction type to add to the team discussion.
", "enum": [ "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes" ], "name": "content", "in": "body", "rawType": "string", "rawDescription": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "content": "heart" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "node_id": "MDg6UmVhY3Rpb24x", "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 }, "content": "heart", "created_at": "2016-05-20T20:09:31Z" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
Created
" } ], "subcategory": "reactions" } ] }, "releases": { "releases": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "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 }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "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 } } ] } ] } } ], "previews": [], "descriptionHTML": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The name of the tag.
", "name": "tag_name", "in": "body", "rawType": "string", "rawDescription": "The name of the tag.", "childParamsGroups": [] }, { "type": "string", "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
The name of the release.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the release.", "childParamsGroups": [] }, { "type": "string", "description": "Text describing the contents of the tag.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "Text describing the contents of the tag.", "childParamsGroups": [] }, { "type": "boolean", "description": "true to create a draft (unpublished) release, false to create a published one.
true to identify the release as a prerelease. false to identify the release as a full release.
If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"
", "name": "discussion_category_name", "in": "body", "rawType": "string", "rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"", "childParamsGroups": [] }, { "type": "boolean", "description": "Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.
Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "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 }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "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 } } ] } } } ], "previews": [], "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Not Found if the discussion category name is invalid
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", "title": "Generate release notes content for a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The tag name for the release. This can be an existing tag or a new one.
", "name": "tag_name", "in": "body", "rawType": "string", "rawDescription": "The tag name for the release. This can be an existing tag or a new one.", "childParamsGroups": [] }, { "type": "string", "description": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.
", "name": "target_commitish", "in": "body", "rawType": "string", "rawDescription": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.", "childParamsGroups": [] }, { "type": "string", "description": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.
", "name": "previous_tag_name", "in": "body", "rawType": "string", "rawDescription": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.", "childParamsGroups": [] }, { "type": "string", "description": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.
", "name": "configuration_file_path", "in": "body", "rawType": "string", "rawDescription": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", "target_commitish": "main", "previous_tag_name": "v0.9.2", "configuration_file_path": ".github/custom_release_config.yml" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Name and body of generated release notes
", "example": { "name": "Release v1.0.0 is now available!", "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa" } } } ], "previews": [], "descriptionHTML": "Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
", "statusCodes": [ { "httpStatusCode": "200", "description": "Name and body of generated release notes
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "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 }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "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 } } ] } } } ], "previews": [], "descriptionHTML": "View the latest published full release for the repository.
\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "tag parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "tag": "TAG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "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 }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "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 } } ] } } } ], "previews": [], "descriptionHTML": "Get a published release with the specified tag.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "release_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "release_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "release_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "release_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "The name of the tag.
", "name": "tag_name", "in": "body", "rawType": "string", "rawDescription": "The name of the tag.", "childParamsGroups": [] }, { "type": "string", "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).
The name of the release.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the release.", "childParamsGroups": [] }, { "type": "string", "description": "Text describing the contents of the tag.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "Text describing the contents of the tag.", "childParamsGroups": [] }, { "type": "boolean", "description": "true makes the release a draft, and false publishes the release.
true to identify the release as a prerelease, false to identify the release as a full release.
If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"
", "name": "discussion_category_name", "in": "body", "rawType": "string", "rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false }, "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", "id": 1, "node_id": "MDc6UmVsZWFzZTE=", "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0", "body": "Description of the release", "draft": false, "prerelease": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { "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 }, "assets": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "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 } } ] } } } ], "previews": [], "descriptionHTML": "Users with push access to the repository can edit a release.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Not Found if the discussion category name is invalid
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", "subcategory": "releases", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "release_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "release_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Users with push access to the repository can delete a release.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "assets": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "title": "Get a release asset", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "asset_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "asset_id": "ASSET_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.
Found
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "title": "Update a release asset", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "asset_id parameter
" } ], "bodyParameters": [ { "type": "string", "description": "The file name of the asset.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The file name of the asset.", "childParamsGroups": [] }, { "type": "string", "description": "An alternate short description of the asset. Used in place of the filename.
", "name": "label", "in": "body", "rawType": "string", "rawDescription": "An alternate short description of the asset. Used in place of the filename.", "childParamsGroups": [] }, { "type": "string", "examples": [ "\"uploaded\"" ], "name": "state", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "foo-1.0.0-osx.zip", "label": "Mac binary" }, "parameters": { "owner": "OWNER", "repo": "REPO", "asset_id": "ASSET_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "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 } } } } ], "previews": [], "descriptionHTML": "Users with push access to the repository can edit a release asset.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "title": "Delete a release asset", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "asset_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "asset_id": "ASSET_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "List release assets", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "release_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "release_id parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "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 } } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://uploads.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "Upload a release asset", "category": "releases", "subcategory": "assets", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "release_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "release_id parameter
" }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "label", "in": "query", "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "*/*", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "release_id": "RELEASE_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response for successful upload
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", "id": 1, "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", "name": "example.zip", "label": "short description", "state": "uploaded", "content_type": "application/zip", "size": 1024, "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", "uploader": { "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 } } } } ], "previews": [], "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\n- \n
- GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List assets for a release\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Support. \n
- If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. \n
Response for successful upload
" }, { "httpStatusCode": "422", "description": "Response if you upload an asset with the same filename as another uploaded asset
" } ] } ] }, "repos": { "repos": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/repos", "title": "List organization repositories", "category": "repos", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "public", "private", "forks", "sources", "member", "internal" ] }, "descriptionHTML": "Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal. However, the internal value is not yet supported when a GitHub App calls this API with an installation access token.
Can be one of created, updated, pushed, full_name.
Can be one of asc or desc. Default: when using full_name: asc, otherwise desc
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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": false, "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": null } ] } } ], "previews": [], "descriptionHTML": "Lists repositories for the specified organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/repos", "title": "Create an organization repository", "category": "repos", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The name of the repository.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the repository.", "childParamsGroups": [] }, { "type": "string", "description": "A short description of the repository.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A short description of the repository.", "childParamsGroups": [] }, { "type": "string", "description": "A URL with more information about the repository.
", "name": "homepage", "in": "body", "rawType": "string", "rawDescription": "A URL with more information about the repository.", "childParamsGroups": [] }, { "type": "boolean", "description": "Whether the repository is private.
", "default": false, "name": "private", "in": "body", "rawType": "boolean", "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "type": "string", "description": "Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
Either true to enable issues for this repository or false to disable them.
Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.
Either true to enable the wiki for this repository or false to disable it.
Either true to make this repo available as a template repository or false to prevent it.
The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
", "name": "team_id", "in": "body", "rawType": "integer", "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", "childParamsGroups": [] }, { "type": "boolean", "description": "Pass true to create an initial commit with empty README.
Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".
", "name": "gitignore_template", "in": "body", "rawType": "string", "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", "childParamsGroups": [] }, { "type": "string", "description": "Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".
Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.
Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Either true to allow auto-merge on pull requests, or false to disallow auto-merge.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
Response
", "example": { "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 } } } ], "previews": [], "descriptionHTML": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n- \n
public_reposcope orreposcope to create a public repository. Note: For GitHub AE, usereposcope to create an internal repository. \nreposcope to create a private repository \n
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}", "title": "Get a repository", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "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, "forks": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "open_issues": 0, "is_template": false, "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": { "pull": true, "push": false, "admin": false }, "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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, "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", "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", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==" }, "organization": { "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": "Organization", "site_admin": false }, "parent": { "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "source": { "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } } } } ], "previews": [], "descriptionHTML": "The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.
OK
" }, { "httpStatusCode": "301", "description": "Moved permanently
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}", "title": "Update a repository", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The name of the repository.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the repository.", "childParamsGroups": [] }, { "type": "string", "description": "A short description of the repository.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A short description of the repository.", "childParamsGroups": [] }, { "type": "string", "description": "A URL with more information about the repository.
", "name": "homepage", "in": "body", "rawType": "string", "rawDescription": "A URL with more information about the repository.", "childParamsGroups": [] }, { "type": "boolean", "description": "Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.
Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"
Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: {\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.
Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"
Can be enabled or disabled.
Can be enabled or disabled.
Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"
Can be enabled or disabled.
Can be enabled or disabled.
Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"
Can be enabled or disabled.
Can be enabled or disabled.
Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"
Can be enabled or disabled.
Can be enabled or disabled.
Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"
Can be enabled or disabled.
Can be enabled or disabled.
Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"
Can be enabled or disabled.
Can be enabled or disabled.
Can be enabled or disabled.
Can be enabled or disabled.
Can be enabled or disabled.
Either true to enable issues for this repository or false to disable them.
Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.
Either true to enable the wiki for this repository or false to disable it.
Either true to make this repo available as a template repository or false to prevent it.
Updates the default branch for this repository.
", "name": "default_branch", "in": "body", "rawType": "string", "rawDescription": "Updates the default branch for this repository.", "childParamsGroups": [] }, { "type": "boolean", "description": "Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.
Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Either true to allow auto-merge on pull requests, or false to disallow auto-merge.
Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.
true to archive this repository. Note: You cannot unarchive repositories through the API.
Either true to allow private forks, or false to prevent private forks.
Response
", "example": { "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", "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" }, "language": null, "forks_count": 9, "forks": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "open_issues": 0, "is_template": false, "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": { "pull": true, "push": false, "admin": false }, "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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, "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", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "allow_forking": true, "subscribers_count": 42, "network_count": 0, "organization": { "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": "Organization", "site_admin": false }, "parent": { "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "source": { "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } } } } ], "previews": [], "descriptionHTML": "Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "307", "description": "Temporary Redirect
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}", "title": "Delete a repository", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.
No Content
" }, { "httpStatusCode": "307", "description": "Temporary Redirect
" }, { "httpStatusCode": "403", "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/automated-security-fixes", "title": "Enable automated security fixes", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"Configuring automated security fixes\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/automated-security-fixes", "title": "Disable automated security fixes", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"Configuring automated security fixes\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/codeowners/errors", "title": "List CODEOWNERS errors", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. main)
Response
", "example": { "errors": [ { "line": 3, "column": 1, "kind": "Invalid pattern", "source": "***/*.rb @monalisa", "suggestion": "Did you mean `**/*.rb`?", "message": "Invalid pattern on line 3: Did you mean `**/*.rb`?\n\n ***/*.rb @monalisa\n ^", "path": ".github/CODEOWNERS" }, { "line": 7, "column": 7, "kind": "Invalid owner", "source": "*.txt docs@", "suggestion": null, "message": "Invalid owner on line 7:\n\n *.txt docs@\n ^", "path": ".github/CODEOWNERS" } ] } } } ], "previews": [], "descriptionHTML": "List any syntax errors that are detected in the CODEOWNERS\nfile.
\nFor more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/contributors", "title": "List repository contributors", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "anon", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "Set to 1 or true to include anonymous contributors in results.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "response-if-repository-contains-content", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if repository contains content
", "example": [ { "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, "contributions": 32 } ] } } ], "previews": [], "descriptionHTML": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
", "statusCodes": [ { "httpStatusCode": "200", "description": "if repository contains content
" }, { "httpStatusCode": "204", "description": "Response if repository is empty
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/dispatches", "title": "Create a repository dispatch event", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. A custom webhook event name.
", "minLength": 1, "maxLength": 100, "name": "event_type", "in": "body", "rawType": "string", "rawDescription": "A custom webhook event name.", "childParamsGroups": [] }, { "type": "object", "description": "JSON payload with extra information about the webhook event that your action or worklow may use.
", "additionalProperties": true, "maxProperties": 10, "name": "client_payload", "in": "body", "rawType": "object", "rawDescription": "JSON payload with extra information about the webhook event that your action or worklow may use.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "event_type": "on-demand-test", "client_payload": { "unit": false, "integration": true } }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"
The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.
This endpoint requires write access to the repository by providing either:
\n- \n
- Personal access tokens with
reposcope. For more information, see \"Creating a personal access token for the command line\" in the GitHub Help documentation. \n - GitHub Apps with both
metadata:readandcontents:read&writepermissions. \n
This input example shows how you can use the client_payload as a test to debug your workflow.
No Content
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages", "title": "List repository languages", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "C": 78769, "Python": 7769 } } } ], "previews": [], "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags", "title": "List repository tags", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "name": "v0.1", "commit": { "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" }, "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1", "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1", "node_id": "MDQ6VXNlcjE=" } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/teams", "title": "List repository teams", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/topics", "title": "Get all repository topics", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "names": [ "octocat", "atom", "electron", "api" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/topics", "title": "Replace all repository topics", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "array of strings", "description": "Required. An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.
Response
", "example": { "names": [ "octocat", "atom", "electron", "api" ] } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/transfer", "title": "Transfer a repository", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The username or organization name the repository will be transferred to.
", "name": "new_owner", "in": "body", "rawType": "string", "rawDescription": "The username or organization name the repository will be transferred to.", "childParamsGroups": [] }, { "type": "array of integers", "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
", "items": { "type": "integer" }, "name": "team_ids", "in": "body", "rawType": "array", "rawDescription": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "new_owner": "github", "team_ids": [ 12, 345 ] }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { "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": false, "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-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "allow_forking": true, "subscribers_count": 42, "network_count": 0 } } } } ], "previews": [], "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Accepted
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", "title": "Check if vulnerability alerts are enabled for a repository", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response if repository is enabled with vulnerability alerts
" } } ], "previews": [], "descriptionHTML": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "Response if repository is enabled with vulnerability alerts
" }, { "httpStatusCode": "404", "description": "Not Found if repository is not enabled with vulnerability alerts
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", "title": "Enable vulnerability alerts", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/vulnerability-alerts", "title": "Disable vulnerability alerts", "category": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{template_owner}/{template_repo}/generate", "title": "Create a repository using a template", "category": "repos", "parameters": [ { "name": "template_owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "template_repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.
", "name": "owner", "in": "body", "rawType": "string", "rawDescription": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The name of the new repository.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the new repository.", "childParamsGroups": [] }, { "type": "string", "description": "A short description of the new repository.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A short description of the new repository.", "childParamsGroups": [] }, { "type": "boolean", "description": "Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.
Either true to create a new private repository or false to create a new public one.
Response
", "example": { "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, "forks": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "open_issues": 0, "is_template": false, "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, "allow_auto_merge": false, "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" } } } } ], "previews": [], "descriptionHTML": "Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.
OAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n- \n
public_reposcope orreposcope to create a public repository. Note: For GitHub AE, usereposcope to create an internal repository. \nreposcope to create a private repository \n
Created
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repositories", "title": "List public repositories", "category": "repos", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "A repository ID. Only return repositories with an ID greater than this ID.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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" } ] } } ], "previews": [], "descriptionHTML": "Lists all public repositories in the order that they were created.
\nNote:
\n- \n
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. \n
- Pagination is powered exclusively by the
sinceparameter. Use the Link header to get the URL for the next page of repositories. \n
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/repos", "title": "List repositories for the authenticated user", "category": "repos", "parameters": [ { "name": "visibility", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "public", "private" ], "default": "all" }, "descriptionHTML": "Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.
Comma-separated list of values. Can include:
\n* owner: Repositories that are owned by the authenticated user.
\n* collaborator: Repositories that the user has been added to as a collaborator.
\n* organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all
Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.
Can be one of created, updated, pushed, full_name.
Can be one of asc or desc. Default: asc when using full_name, otherwise desc
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "descriptionHTML": "Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Default response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.
The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/repos", "title": "Create a repository for the authenticated user", "category": "repos", "parameters": [], "bodyParameters": [ { "description": "Required. The name of the repository.
", "type": "string", "examples": [ "Team Environment" ], "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the repository.", "childParamsGroups": [] }, { "description": "A short description of the repository.
", "type": "string", "name": "description", "in": "body", "rawType": "string", "rawDescription": "A short description of the repository.", "childParamsGroups": [] }, { "description": "A URL with more information about the repository.
", "type": "string", "name": "homepage", "in": "body", "rawType": "string", "rawDescription": "A URL with more information about the repository.", "childParamsGroups": [] }, { "description": "Whether the repository is private.
", "default": false, "type": "boolean", "name": "private", "in": "body", "rawType": "boolean", "rawDescription": "Whether the repository is private.", "childParamsGroups": [] }, { "description": "Whether issues are enabled.
", "default": true, "type": "boolean", "examples": [ true ], "name": "has_issues", "in": "body", "rawType": "boolean", "rawDescription": "Whether issues are enabled.", "childParamsGroups": [] }, { "description": "Whether projects are enabled.
", "default": true, "type": "boolean", "examples": [ true ], "name": "has_projects", "in": "body", "rawType": "boolean", "rawDescription": "Whether projects are enabled.", "childParamsGroups": [] }, { "description": "Whether the wiki is enabled.
", "default": true, "type": "boolean", "examples": [ true ], "name": "has_wiki", "in": "body", "rawType": "boolean", "rawDescription": "Whether the wiki is enabled.", "childParamsGroups": [] }, { "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
", "type": "integer", "name": "team_id", "in": "body", "rawType": "integer", "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", "childParamsGroups": [] }, { "description": "Whether the repository is initialized with a minimal README.
", "default": false, "type": "boolean", "name": "auto_init", "in": "body", "rawType": "boolean", "rawDescription": "Whether the repository is initialized with a minimal README.", "childParamsGroups": [] }, { "description": "The desired language or platform to apply to the .gitignore.
", "type": "string", "examples": [ "Haskell" ], "name": "gitignore_template", "in": "body", "rawType": "string", "rawDescription": "The desired language or platform to apply to the .gitignore.", "childParamsGroups": [] }, { "description": "The license keyword of the open source license for this repository.
", "type": "string", "examples": [ "mit" ], "name": "license_template", "in": "body", "rawType": "string", "rawDescription": "The license keyword of the open source license for this repository.", "childParamsGroups": [] }, { "description": "Whether to allow squash merges for pull requests.
", "default": true, "type": "boolean", "examples": [ true ], "name": "allow_squash_merge", "in": "body", "rawType": "boolean", "rawDescription": "Whether to allow squash merges for pull requests.", "childParamsGroups": [] }, { "description": "Whether to allow merge commits for pull requests.
", "default": true, "type": "boolean", "examples": [ true ], "name": "allow_merge_commit", "in": "body", "rawType": "boolean", "rawDescription": "Whether to allow merge commits for pull requests.", "childParamsGroups": [] }, { "description": "Whether to allow rebase merges for pull requests.
", "default": true, "type": "boolean", "examples": [ true ], "name": "allow_rebase_merge", "in": "body", "rawType": "boolean", "rawDescription": "Whether to allow rebase merges for pull requests.", "childParamsGroups": [] }, { "description": "Whether to allow Auto-merge to be used on pull requests.
", "default": false, "type": "boolean", "examples": [ false ], "name": "allow_auto_merge", "in": "body", "rawType": "boolean", "rawDescription": "Whether to allow Auto-merge to be used on pull requests.", "childParamsGroups": [] }, { "description": "Whether to delete head branches when pull requests are merged
", "default": false, "type": "boolean", "examples": [ false ], "name": "delete_branch_on_merge", "in": "body", "rawType": "boolean", "rawDescription": "Whether to delete head branches when pull requests are merged", "childParamsGroups": [] }, { "description": "Whether downloads are enabled.
", "default": true, "type": "boolean", "examples": [ true ], "name": "has_downloads", "in": "body", "rawType": "boolean", "rawDescription": "Whether downloads are enabled.", "childParamsGroups": [] }, { "description": "Whether this repository acts as a template that can be used to generate new repositories.
", "default": false, "type": "boolean", "examples": [ true ], "name": "is_template", "in": "body", "rawType": "boolean", "rawDescription": "Whether this repository acts as a template that can be used to generate new repositories.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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 } } } ], "previews": [], "descriptionHTML": "Creates a new repository for the authenticated user.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\n- \n
public_reposcope orreposcope to create a public repository. Note: For GitHub AE, usereposcope to create an internal repository. \nreposcope to create a private repository. \n
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "repos" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/repos", "title": "List repositories for a user", "category": "repos", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "owner", "member" ], "default": "owner" }, "descriptionHTML": "Can be one of all, owner, member.
Can be one of created, updated, pushed, full_name.
Can be one of asc or desc. Default: asc when using full_name, otherwise desc
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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": false, "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": null } ] } } ], "previews": [], "descriptionHTML": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ], "subcategory": "repos" } ], "autolinks": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/autolinks", "title": "List all autolinks of a repository", "category": "repos", "subcategory": "autolinks", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=This returns a list of autolinks configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/autolinks", "title": "Create an autolink reference for a repository", "category": "repos", "subcategory": "autolinks", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
", "name": "key_prefix", "in": "body", "rawType": "string", "rawDescription": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The URL must contain
response
", "example": { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=Users with admin access to the repository can create an autolink.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", "title": "Get an autolink reference of a repository", "category": "repos", "subcategory": "autolinks", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "autolink_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "autolink_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "autolink_id": "AUTOLINK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=This returns a single autolink reference by ID that was configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}", "title": "Delete an autolink reference from a repository", "category": "repos", "subcategory": "autolinks", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "autolink_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "autolink_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "autolink_id": "AUTOLINK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This deletes a single autolink reference by ID that was configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "contents": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", "title": "Get repository content", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "path parameter
" }, { "name": "ref", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
Response if content is a file
", "example": { "type": "file", "encoding": "base64", "size": 5362, "name": "README.md", "path": "README.md", "content": "encoded content ...", "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" } } } }, { "key": "response-if-content-is-a-directory", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if content is a directory
", "example": [ { "type": "file", "size": 625, "name": "octokit.rb", "path": "lib/octokit.rb", "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", "html_url": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb", "_links": { "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", "html": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb" } }, { "type": "dir", "size": 0, "name": "octokit", "path": "lib/octokit", "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "html_url": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit", "download_url": null, "_links": { "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", "git": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", "html": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit" } } ] } }, { "key": "response-if-content-is-a-symlink", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if content is a symlink
", "example": { "type": "symlink", "target": "/path/to/symlink/target", "size": 23, "name": "some-symlink", "path": "bin/some-symlink", "sha": "452a98979c88e093d682cab404a3ec82babebb48", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", "html_url": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", "html": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink" } } } }, { "key": "response-if-content-is-a-submodule", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if content is a submodule
", "example": { "type": "submodule", "submodule_git_url": "git://github.com/jquery/qunit.git", "size": 0, "name": "qunit", "path": "test/qunit", "sha": "6ca3721222109997540bd6d9ccd396902e0ad2f9", "url": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", "git_url": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", "html_url": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9", "download_url": null, "_links": { "git": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", "self": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", "html": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9" } } } } ], "previews": [], "descriptionHTML": "Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNote:
\n- \n
- To get a repository's contents recursively, you can recursively get the tree. \n
- This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI. \n
- This API supports files up to 1 megabyte in size. \n
If the content is a directory
\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\nIf the content is a symlink
\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.
If the content is a submodule
\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.
If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.
OK
" }, { "httpStatusCode": "302", "description": "Found
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/contents/{path}", "title": "Create or update file contents", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "path parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The commit message.
", "name": "message", "in": "body", "rawType": "string", "rawDescription": "The commit message.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The new file content, using Base64 encoding.
", "name": "content", "in": "body", "rawType": "string", "rawDescription": "The new file content, using Base64 encoding.", "childParamsGroups": [] }, { "type": "string", "description": "Required if you are updating a file. The blob SHA of the file being replaced.
", "name": "sha", "in": "body", "rawType": "string", "rawDescription": "**Required if you are updating a file**. The blob SHA of the file being replaced.", "childParamsGroups": [] }, { "type": "string", "description": "The branch name. Default: the repository’s default branch (usually master)
The person that committed the file. Default: the authenticated user.
", "properties": { "name": { "type": "string", "description": "Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
The author of the file. Default: The committer or the authenticated user if you omit committer.
Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
Required. The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.
Required. The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.
Response
", "example": { "content": { "name": "hello.txt", "path": "notes/hello.txt", "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3", "size": 9, "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", "type": "file", "_links": { "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" } }, "commit": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "my commit message", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", "sha": "691272480426f78a0138979dd3ce63b77f706feb" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } } } }, { "key": "example-for-updating-a-file", "request": { "contentType": "application/json", "description": "Example for updating a file", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "a new commit message", "committer": { "name": "Monalisa Octocat", "email": "octocat@github.com" }, "content": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz", "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3" }, "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content": { "name": "hello.txt", "path": "notes/hello.txt", "sha": "a56507ed892d05a37c6d6128c260937ea4d287bd", "size": 9, "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", "type": "file", "_links": { "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" } }, "commit": { "sha": "18a43cd8e1e3a79c786e3d808a73d23b6d212b16", "node_id": "MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", "html_url": "https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "my commit message", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f", "sha": "9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6", "html_url": "https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6", "sha": "da5a433788da5c255edad7979b328b67d79f53f6" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } } } } ], "previews": [], "descriptionHTML": "Creates a new file or replaces an existing file in a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/contents/{path}", "title": "Delete a file", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "path parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The commit message.
", "name": "message", "in": "body", "rawType": "string", "rawDescription": "The commit message.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The blob SHA of the file being replaced.
", "name": "sha", "in": "body", "rawType": "string", "rawDescription": "The blob SHA of the file being replaced.", "childParamsGroups": [] }, { "type": "string", "description": "The branch name. Default: the repository’s default branch (usually master)
object containing information about the committer.
", "properties": { "name": { "type": "string", "description": "The name of the author (or committer) of the commit
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author (or committer) of the commit", "childParamsGroups": [] }, "email": { "type": "string", "description": "The email of the author (or committer) of the commit
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author (or committer) of the commit", "childParamsGroups": [] } }, "name": "committer", "in": "body", "rawType": "object", "rawDescription": "object containing information about the committer.", "childParamsGroups": [ { "parentName": "committer", "parentType": "object", "id": "committer-object", "params": [ { "type": "string", "description": "The name of the author (or committer) of the commit
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author (or committer) of the commit", "childParamsGroups": [] }, { "type": "string", "description": "The email of the author (or committer) of the commit
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author (or committer) of the commit", "childParamsGroups": [] } ] } ] }, { "type": "object", "description": "object containing information about the author.
", "properties": { "name": { "type": "string", "description": "The name of the author (or committer) of the commit
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author (or committer) of the commit", "childParamsGroups": [] }, "email": { "type": "string", "description": "The email of the author (or committer) of the commit
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author (or committer) of the commit", "childParamsGroups": [] } }, "name": "author", "in": "body", "rawType": "object", "rawDescription": "object containing information about the author.", "childParamsGroups": [ { "parentName": "author", "parentType": "object", "id": "author-object", "params": [ { "type": "string", "description": "The name of the author (or committer) of the commit
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the author (or committer) of the commit", "childParamsGroups": [] }, { "type": "string", "description": "The email of the author (or committer) of the commit
", "name": "email", "in": "body", "rawType": "string", "rawDescription": "The email of the author (or committer) of the commit", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "message": "my commit message", "committer": { "name": "Monalisa Octocat", "email": "octocat@github.com" }, "sha": "329688480d39049927147c162b9d2deaf885005f" }, "parameters": { "owner": "OWNER", "repo": "REPO", "path": "PATH" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content": null, "commit": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", "author": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "committer": { "date": "2014-11-07T22:01:45Z", "name": "Monalisa Octocat", "email": "octocat@github.com" }, "message": "my commit message", "tree": { "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", "sha": "691272480426f78a0138979dd3ce63b77f706feb" }, "parents": [ { "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" } ], "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null } } } } } ], "previews": [], "descriptionHTML": "Deletes a file in a repository.
\nYou can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.
The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.
You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme", "title": "Get a repository README", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
Response
", "example": { "type": "file", "encoding": "base64", "size": 5362, "name": "README.md", "path": "README.md", "content": "encoded content ...", "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" } } } } ], "previews": [], "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/readme/{dir}", "title": "Get a repository README for a directory", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "dir", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true, "descriptionHTML": "The alternate path to look for a README file
" }, { "name": "ref", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
Response
", "example": { "type": "file", "encoding": "base64", "size": 5362, "name": "README.md", "path": "README.md", "content": "encoded content ...", "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", "_links": { "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" } } } } ], "previews": [], "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/tarball/{ref}", "title": "Download a repository archive (tar)", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.\nNote: For private repositories, these links are temporary and expire after five minutes.
Found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/zipball/{ref}", "title": "Download a repository archive (zip)", "category": "repos", "subcategory": "contents", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "ref": "REF" } }, "response": { "statusCode": "302", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually\nmaster) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.\nNote: For private repositories, these links are temporary and expire after five minutes.
Found
" } ] } ], "forks": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/forks", "title": "List forks", "category": "repos", "subcategory": "forks", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "newest", "oldest", "stargazers", "watchers" ], "default": "newest" }, "descriptionHTML": "The sort order. Can be either newest, oldest, or stargazers.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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": true, "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 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "spdx_id": "MIT", "url": "https://api.github.com/licenses/mit", "node_id": "MDc6TGljZW5zZW1pdA==" } } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/forks", "title": "Create a fork", "category": "repos", "subcategory": "forks", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Optional parameter to specify the organization name if forking into an organization.
", "name": "organization", "in": "body", "rawType": "string", "rawDescription": "Optional parameter to specify the organization name if forking into an organization.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "202", "contentType": "application/json", "description": "Response
", "example": { "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", "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" }, "language": null, "forks_count": 9, "forks": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "open_issues": 0, "is_template": false, "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": { "pull": true, "push": false, "admin": false }, "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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, "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", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "allow_forking": true, "subscribers_count": 42, "network_count": 0, "organization": { "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": "Organization", "site_admin": false }, "parent": { "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 }, "source": { "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } } } } ], "previews": [], "descriptionHTML": "Create a fork for the authenticated user.
\nNote: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact GitHub Support.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "lfs": [ { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/repos/{owner}/{repo}/lfs", "title": "Enable Git LFS for a repository", "category": "repos", "subcategory": "lfs", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "403", "description": "We will return a 403 with one of the following messages:
\n- \n
- Git LFS support not enabled because Git LFS is globally disabled. \n
- Git LFS support not enabled because Git LFS is disabled for the root repository in the network. \n
- Git LFS support not enabled because Git LFS is disabled for
. \n
Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "tags": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/tags/protection", "title": "List tag protection states for a repository", "category": "repos", "subcategory": "tags", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 2, "pattern": "v1.*" } ] } } ], "previews": [], "descriptionHTML": "This returns the tag protection states of a repository.
\nThis information is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/tags/protection", "title": "Create a tag protection state for a repository", "category": "repos", "subcategory": "tags", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. An optional glob pattern to match against when enforcing tag protection.
", "name": "pattern", "in": "body", "rawType": "string", "rawDescription": "An optional glob pattern to match against when enforcing tag protection.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "pattern": "v1.*" }, "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "enabled": true } } } ], "previews": [], "descriptionHTML": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}", "title": "Delete a tag protection state for a repository", "category": "repos", "subcategory": "tags", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "tag_protection_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "tag_protection_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "tag_protection_id": "TAG_PROTECTION_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] }, "scim": { "scim": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/organizations/{org}/Users", "title": "List SCIM provisioned identities", "category": "scim", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "startIndex", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "Used for pagination: the index of the first result to return.
" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "Used for pagination: the number of results to return.
" }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query:
?filter=userName%20eq%20\\\"Octocat\\\".
To filter results for the identity with the email octocat@github.com, you would use this query:
?filter=emails%20eq%20\\\"octocat@github.com\\\".
Response with filter
", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 1, "itemsPerPage": 1, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "5fc0c238-1112-11e8-8e45-920c87bdbd75", "externalId": "00u1dhhb1fkIGP7RL1d8", "userName": "octocat@github.com", "displayName": "Mona Octocat", "name": { "givenName": "Mona", "familyName": "Octocat", "formatted": "Mona Octocat" }, "emails": [ { "value": "octocat@github.com", "primary": true } ], "active": true, "meta": { "resourceType": "User", "created": "2018-02-13T15:05:24.000-08:00", "lastModified": "2018-02-13T15:05:55.000-08:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/5fc0c238-1112-11e8-8e45-920c87bdbd75" } } ] } } }, { "key": "response-without-filter", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/scim+json", "description": "Response without filter
", "example": { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 2, "itemsPerPage": 2, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Mona Octocat", "name": { "givenName": "Mona", "familyName": "Octocat", "formatted": "Mona Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }, { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "77563764-eb6-24-0598234-958243", "externalId": "sdfoiausdofiua", "userName": "hubot@example.com", "displayName": "hu bot", "name": { "givenName": "hu", "familyName": "bot", "formatted": "hu bot" }, "emails": [ { "value": "hubot@example.com", "primary": true } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243" } } ] } } } ], "previews": [], "descriptionHTML": "Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the filter parameter, the resources for all matching provisions members are returned.
When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:
\n- \n
- When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. \n
- When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). \n
- When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. \n
The returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:
- \n
- \n
The user is granted access by the IdP and is not a member of the GitHub organization.
\n \n - \n
The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account.
\n \n - \n
After successfully authenticating with the SAML SSO IdP, the
\nnullexternal identity entry is created and the user is prompted to sign in to their GitHub account:- \n
- If the user signs in, their GitHub account is linked to this entry. \n
- If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity
nullentry remains in place. \n
\n
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "429", "description": "Too Many Requests
" } ], "subcategory": "scim" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/scim/v2/organizations/{org}/Users", "title": "Provision and invite a SCIM user", "category": "scim", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "description": "Required. Configured by the admin. Could be an email, login, or username
", "type": "string", "examples": [ "someone@example.com" ], "name": "userName", "in": "body", "rawType": "string", "rawDescription": "Configured by the admin. Could be an email, login, or username", "childParamsGroups": [] }, { "description": "The name of the user, suitable for display to end-users
", "type": "string", "examples": [ "Jon Doe" ], "name": "displayName", "in": "body", "rawType": "string", "rawDescription": "The name of the user, suitable for display to end-users", "childParamsGroups": [] }, { "type": "object", "properties": { "givenName": { "type": "string", "name": "givenName", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, "familyName": { "type": "string", "name": "familyName", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, "formatted": { "type": "string", "name": "formatted", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } }, "required": [ "givenName", "familyName" ], "example": { "givenName": "Jane", "familyName": "User" }, "name": "name", "in": "body", "rawType": "object", "description": "Required.
", "childParamsGroups": [ { "parentName": "name", "parentType": "object", "id": "name-object", "params": [ { "type": "string", "name": "givenName", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, { "type": "string", "name": "familyName", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, { "type": "string", "name": "formatted", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ] } ] }, { "description": "Required. user emails
", "type": "array of objects", "minItems": 1, "items": { "type": "object", "properties": { "value": { "type": "string", "name": "value", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, "primary": { "type": "boolean", "name": "primary", "in": "body", "rawType": "boolean", "description": "", "childParamsGroups": [] }, "type": { "type": "string", "name": "type", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } }, "required": [ "value" ] }, "examples": [ { "value": "someone@example.com", "primary": true }, { "value": "another@example.com", "primary": false } ], "name": "emails", "in": "body", "rawType": "array", "rawDescription": "user emails", "childParamsGroups": [ { "parentName": "emails", "parentType": "items", "id": "emails-items", "params": [ { "type": "string", "name": "value", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, { "type": "boolean", "name": "primary", "in": "body", "rawType": "boolean", "description": "", "childParamsGroups": [] }, { "type": "string", "name": "type", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ] } ] }, { "type": "array of strings", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "description": "", "childParamsGroups": [] }, { "type": "string", "name": "externalId", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, { "type": "array of strings", "items": { "type": "string" }, "name": "groups", "in": "body", "rawType": "array", "description": "", "childParamsGroups": [] }, { "type": "boolean", "name": "active", "in": "body", "rawType": "boolean", "description": "", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/scim+json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } } } } ], "previews": [], "descriptionHTML": "Provision organization membership for a user, and send an activation email to the email address.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "409", "description": "Conflict
" }, { "httpStatusCode": "500", "description": "Internal Error
" } ], "subcategory": "scim" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/scim/v2/organizations/{org}/Users/{scim_user_id}", "title": "Get SCIM provisioning information for a user", "category": "scim", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "scim_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "scim_user_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/scim+json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } } } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "scim" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/scim/v2/organizations/{org}/Users/{scim_user_id}", "title": "Update a provisioned organization membership", "category": "scim", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "scim_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "scim_user_id parameter
" } ], "bodyParameters": [ { "type": "array of strings", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "description": "", "childParamsGroups": [] }, { "description": "The name of the user, suitable for display to end-users
", "type": "string", "examples": [ "Jon Doe" ], "name": "displayName", "in": "body", "rawType": "string", "rawDescription": "The name of the user, suitable for display to end-users", "childParamsGroups": [] }, { "type": "string", "name": "externalId", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, { "type": "array of strings", "items": { "type": "string" }, "name": "groups", "in": "body", "rawType": "array", "description": "", "childParamsGroups": [] }, { "type": "boolean", "name": "active", "in": "body", "rawType": "boolean", "description": "", "childParamsGroups": [] }, { "description": "Required. Configured by the admin. Could be an email, login, or username
", "type": "string", "examples": [ "someone@example.com" ], "name": "userName", "in": "body", "rawType": "string", "rawDescription": "Configured by the admin. Could be an email, login, or username", "childParamsGroups": [] }, { "type": "object", "properties": { "givenName": { "type": "string", "name": "givenName", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, "familyName": { "type": "string", "name": "familyName", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, "formatted": { "type": "string", "name": "formatted", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } }, "required": [ "givenName", "familyName" ], "example": { "givenName": "Jane", "familyName": "User" }, "name": "name", "in": "body", "rawType": "object", "description": "Required.
", "childParamsGroups": [ { "parentName": "name", "parentType": "object", "id": "name-object", "params": [ { "type": "string", "name": "givenName", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, { "type": "string", "name": "familyName", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, { "type": "string", "name": "formatted", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ] } ] }, { "description": "Required. user emails
", "type": "array of objects", "minItems": 1, "items": { "type": "object", "properties": { "type": { "type": "string", "name": "type", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, "value": { "type": "string", "name": "value", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, "primary": { "type": "boolean", "name": "primary", "in": "body", "rawType": "boolean", "description": "", "childParamsGroups": [] } }, "required": [ "value" ] }, "examples": [ { "value": "someone@example.com", "primary": true }, { "value": "another@example.com", "primary": false } ], "name": "emails", "in": "body", "rawType": "array", "rawDescription": "user emails", "childParamsGroups": [ { "parentName": "emails", "parentType": "items", "id": "emails-items", "params": [ { "type": "string", "name": "type", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, { "type": "string", "name": "value", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, { "type": "boolean", "name": "primary", "in": "body", "rawType": "boolean", "description": "", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/scim+json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } } } } ], "previews": [], "descriptionHTML": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
\nYou must at least provide the required values for the user: userName, name, and emails.
Warning: Setting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "scim" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/scim/v2/organizations/{org}/Users/{scim_user_id}", "title": "Update an attribute for a SCIM user", "category": "scim", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "scim_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "scim_user_id parameter
" } ], "bodyParameters": [ { "type": "array of strings", "items": { "type": "string" }, "name": "schemas", "in": "body", "rawType": "array", "description": "", "childParamsGroups": [] }, { "description": "Required. Set of operations to be performed
", "type": "array of objects", "minItems": 1, "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ], "name": "op", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, "path": { "type": "string", "name": "path", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, "value": { "oneOf": [ { "type": "object", "properties": { "active": { "type": [ "boolean", "null" ] }, "userName": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "givenName": { "type": [ "string", "null" ] }, "familyName": { "type": [ "string", "null" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" } } } }, { "type": "string" } ], "name": "value", "in": "body", "type": "object or array or string or ", "description": "", "childParamsGroups": [] } }, "required": [ "op" ] }, "examples": [ { "op": "replace", "value": { "active": false } } ], "name": "Operations", "in": "body", "rawType": "array", "rawDescription": "Set of operations to be performed", "childParamsGroups": [ { "parentName": "Operations", "parentType": "items", "id": "operations-items", "params": [ { "type": "string", "enum": [ "add", "remove", "replace" ], "name": "op", "in": "body", "rawType": "string", "description": "Required.
", "childParamsGroups": [] }, { "type": "string", "name": "path", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, { "oneOf": [ { "type": "object", "properties": { "active": { "type": [ "boolean", "null" ] }, "userName": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "givenName": { "type": [ "string", "null" ] }, "familyName": { "type": [ "string", "null" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "primary": { "type": "boolean" } } } }, { "type": "string" } ], "name": "value", "in": "body", "type": "object or array or string or ", "description": "", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "200", "contentType": "application/scim+json", "description": "Response
", "example": { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "active": true, "meta": { "resourceType": "User", "created": "2017-03-09T16:11:13-05:00", "lastModified": "2017-03-09T16:11:13-05:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } } } } ], "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "429", "description": "Too Many Requests
" } ], "descriptionHTML": "Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.
Warning: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated :scim_user_id.
{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\nscim_user_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "scim_user_id": "SCIM_USER_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "scim" } ] }, "search": { "search": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/code", "title": "Search code", "category": "search", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.
" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "indexed" ] }, "descriptionHTML": "Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 7, "incomplete_results": false, "items": [ { "name": "classes.js", "path": "src/attributes/classes.js", "sha": "d7212f9dee2dcc18f084d7df8f417b80846ded5a", "url": "https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4", "git_url": "https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a", "html_url": "https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js", "repository": { "id": 167174, "node_id": "MDEwOlJlcG9zaXRvcnkxNjcxNzQ=", "name": "jquery", "full_name": "jquery/jquery", "owner": { "login": "jquery", "id": 70142, "node_id": "MDQ6VXNlcjcwMTQy", "avatar_url": "https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png", "gravatar_id": "", "url": "https://api.github.com/users/jquery", "html_url": "https://github.com/jquery", "followers_url": "https://api.github.com/users/jquery/followers", "following_url": "https://api.github.com/users/jquery/following{/other_user}", "gists_url": "https://api.github.com/users/jquery/gists{/gist_id}", "starred_url": "https://api.github.com/users/jquery/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/jquery/subscriptions", "organizations_url": "https://api.github.com/users/jquery/orgs", "repos_url": "https://api.github.com/users/jquery/repos", "events_url": "https://api.github.com/users/jquery/events{/privacy}", "received_events_url": "https://api.github.com/users/jquery/received_events", "type": "Organization", "site_admin": false }, "private": false, "html_url": "https://github.com/jquery/jquery", "description": "jQuery JavaScript Library", "fork": false, "url": "https://api.github.com/repos/jquery/jquery", "forks_url": "https://api.github.com/repos/jquery/jquery/forks", "keys_url": "https://api.github.com/repos/jquery/jquery/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/jquery/jquery/teams", "hooks_url": "https://api.github.com/repos/jquery/jquery/hooks", "issue_events_url": "https://api.github.com/repos/jquery/jquery/issues/events{/number}", "events_url": "https://api.github.com/repos/jquery/jquery/events", "assignees_url": "https://api.github.com/repos/jquery/jquery/assignees{/user}", "branches_url": "https://api.github.com/repos/jquery/jquery/branches{/branch}", "tags_url": "https://api.github.com/repos/jquery/jquery/tags", "blobs_url": "https://api.github.com/repos/jquery/jquery/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/jquery/jquery/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/jquery/jquery/git/refs{/sha}", "trees_url": "https://api.github.com/repos/jquery/jquery/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/jquery/jquery/statuses/{sha}", "languages_url": "https://api.github.com/repos/jquery/jquery/languages", "stargazers_url": "https://api.github.com/repos/jquery/jquery/stargazers", "contributors_url": "https://api.github.com/repos/jquery/jquery/contributors", "subscribers_url": "https://api.github.com/repos/jquery/jquery/subscribers", "subscription_url": "https://api.github.com/repos/jquery/jquery/subscription", "commits_url": "https://api.github.com/repos/jquery/jquery/commits{/sha}", "git_commits_url": "https://api.github.com/repos/jquery/jquery/git/commits{/sha}", "comments_url": "https://api.github.com/repos/jquery/jquery/comments{/number}", "issue_comment_url": "https://api.github.com/repos/jquery/jquery/issues/comments/{number}", "contents_url": "https://api.github.com/repos/jquery/jquery/contents/{+path}", "compare_url": "https://api.github.com/repos/jquery/jquery/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/jquery/jquery/merges", "archive_url": "https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/jquery/jquery/downloads", "issues_url": "https://api.github.com/repos/jquery/jquery/issues{/number}", "pulls_url": "https://api.github.com/repos/jquery/jquery/pulls{/number}", "milestones_url": "https://api.github.com/repos/jquery/jquery/milestones{/number}", "notifications_url": "https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/jquery/jquery/labels{/name}", "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments", "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "score": 1 } ] } } } ], "previews": [], "descriptionHTML": "Searches for query terms inside of a file. This method returns up to 100 results per page.
\nWhen searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.
Considerations for code search
\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:
\n- \n
- Only the default branch is considered. In most cases, this will be the
masterbranch. \n - Only files smaller than 384 KB are searchable. \n
- You must always include at least one search term when searching source code. For example, searching for
language:gois not valid, whileamazing language:gois. \n
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/commits", "title": "Search commits", "category": "search", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.
" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "author-date", "committer-date" ] }, "descriptionHTML": "Sorts the results of your query by author-date or committer-date. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 1, "incomplete_results": false, "items": [ { "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "sha": "bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "html_url": "https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments", "commit": { "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", "author": { "date": "2014-02-04T14:38:36-08:00", "name": "The Octocat", "email": "octocat@nowhere.com" }, "committer": { "date": "2014-02-12T15:18:55-08:00", "name": "The Octocat", "email": "octocat@nowhere.com" }, "message": "Create styles.css and updated README", "tree": { "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68", "sha": "a639e96f9038797fba6e0469f94a4b0cc459fa68" }, "comment_count": 8 }, "author": { "login": "octocat", "id": 583231, "node_id": "MDQ6VXNlcjU4MzIzMQ==", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", "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 }, "committer": {}, "parents": [ { "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", "html_url": "https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", "sha": "a30c19e3f13765a3b48829788bc1cb8b4e95cee4" } ], "repository": { "id": 1300192, "node_id": "MDEwOlJlcG9zaXRvcnkxMzAwMTky", "name": "Spoon-Knife", "full_name": "octocat/Spoon-Knife", "owner": { "login": "octocat", "id": 583231, "node_id": "MDQ6VXNlcjU4MzIzMQ==", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", "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/Spoon-Knife", "description": "This repo is for demonstration purposes only.", "fork": false, "url": "https://api.github.com/repos/octocat/Spoon-Knife", "forks_url": "https://api.github.com/repos/octocat/Spoon-Knife/forks", "keys_url": "https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}", "collaborators_url": "https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}", "teams_url": "https://api.github.com/repos/octocat/Spoon-Knife/teams", "hooks_url": "https://api.github.com/repos/octocat/Spoon-Knife/hooks", "issue_events_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}", "events_url": "https://api.github.com/repos/octocat/Spoon-Knife/events", "assignees_url": "https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}", "branches_url": "https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}", "tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/tags", "blobs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}", "trees_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}", "statuses_url": "https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}", "languages_url": "https://api.github.com/repos/octocat/Spoon-Knife/languages", "stargazers_url": "https://api.github.com/repos/octocat/Spoon-Knife/stargazers", "contributors_url": "https://api.github.com/repos/octocat/Spoon-Knife/contributors", "subscribers_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscription", "commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}", "git_commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}", "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}", "issue_comment_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}", "contents_url": "https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}", "compare_url": "https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}", "merges_url": "https://api.github.com/repos/octocat/Spoon-Knife/merges", "archive_url": "https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}", "downloads_url": "https://api.github.com/repos/octocat/Spoon-Knife/downloads", "issues_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}", "pulls_url": "https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}", "milestones_url": "https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}", "labels_url": "https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}", "releases_url": "https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}", "deployments_url": "https://api.github.com/repos/octocat/Spoon-Knife/deployments" }, "score": 1, "node_id": "MDQ6VXNlcjU4MzIzMQ==" } ] } } } ], "previews": [], "descriptionHTML": "Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.
When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/issues", "title": "Search issues and pull requests", "category": "search", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching issues and pull requests\" for a detailed list of qualifiers.
" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "comments", "reactions", "reactions-+1", "reactions--1", "reactions-smile", "reactions-thinking_face", "reactions-heart", "reactions-tada", "interactions", "created", "updated" ] }, "descriptionHTML": "Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 280, "incomplete_results": false, "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", "id": 35802, "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", "user": { "login": "Nick3C", "id": 90254, "node_id": "MDQ6VXNlcjkwMjU0", "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", "gravatar_id": "", "url": "https://api.github.com/users/Nick3C", "html_url": "https://github.com/Nick3C", "followers_url": "https://api.github.com/users/Nick3C/followers", "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", "organizations_url": "https://api.github.com/users/Nick3C/orgs", "repos_url": "https://api.github.com/users/Nick3C/repos", "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", "received_events_url": "https://api.github.com/users/Nick3C/received_events", "type": "User", "site_admin": true }, "labels": [ { "id": 4, "node_id": "MDU6TGFiZWw0", "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", "name": "bug", "color": "ff0000" } ], "state": "open", "assignee": null, "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" }, "comments": 15, "created_at": "2009-07-12T20:10:41Z", "updated_at": "2009-07-19T09:23:43Z", "closed_at": null, "pull_request": { "url": "https://api/github.com/repos/octocat/Hello-World/pull/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://api.github.com/repos/octocat/Hello-World/pulls/1347" }, "body": "...", "score": 1, "locked": true, "author_association": "COLLABORATOR" } ] } } } ], "previews": [], "descriptionHTML": "Find issues by state and keyword. This method returns up to 100 results per page.
\nWhen searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/labels", "title": "Search labels", "category": "search", "parameters": [ { "name": "repository_id", "in": "query", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "The id of the repository.
" }, { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.
" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "updated" ] }, "descriptionHTML": "Sorts the results of your query by when the label was created or updated. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 2, "incomplete_results": false, "items": [ { "id": 418327088, "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", "name": "enhancement", "color": "84b6eb", "default": true, "description": "New feature or request.", "score": 1 }, { "id": 418327086, "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", "url": "https://api.github.com/repos/octocat/linguist/labels/bug", "name": "bug", "color": "ee0701", "default": true, "description": "Something isn't working.", "score": 1 } ] } } } ], "previews": [], "descriptionHTML": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\nWhen searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/repositories", "title": "Search repositories", "category": "search", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.
" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "stars", "forks", "help-wanted-issues", "updated" ] }, "descriptionHTML": "Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 40, "incomplete_results": false, "items": [ { "id": 3081286, "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", "name": "Tetris", "full_name": "dtrupenn/Tetris", "owner": { "login": "dtrupenn", "id": 872147, "node_id": "MDQ6VXNlcjg3MjE0Nw==", "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", "gravatar_id": "", "url": "https://api.github.com/users/dtrupenn", "received_events_url": "https://api.github.com/users/dtrupenn/received_events", "type": "User", "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}", "site_admin": true }, "private": false, "html_url": "https://github.com/dtrupenn/Tetris", "description": "A C implementation of Tetris using Pennsim through LC4", "fork": false, "url": "https://api.github.com/repos/dtrupenn/Tetris", "created_at": "2012-01-01T00:31:50Z", "updated_at": "2013-01-05T17:58:47Z", "pushed_at": "2012-01-01T00:37:02Z", "homepage": "https://github.com", "size": 524, "stargazers_count": 1, "watchers_count": 1, "language": "Assembly", "forks_count": 0, "open_issues_count": 0, "master_branch": "master", "default_branch": "master", "score": 1, "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", "git_url": "git:github.com/dtrupenn/Tetris.git", "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", "ssh_url": "git@github.com:dtrupenn/Tetris.git", "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", "clone_url": "https://github.com/dtrupenn/Tetris.git", "mirror_url": "git:git.example.com/dtrupenn/Tetris", "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", "svn_url": "https://svn.github.com/dtrupenn/Tetris", "forks": 1, "open_issues": 1, "watchers": 1, "has_issues": true, "has_projects": true, "has_pages": true, "has_wiki": true, "has_downloads": true, "archived": true, "disabled": true, "visibility": "private", "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" } } ] } } } ], "previews": [], "descriptionHTML": "Find repositories via various criteria. This method returns up to 100 results per page.
\nWhen searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/topics", "title": "Search topics", "category": "search", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 6, "incomplete_results": false, "items": [ { "name": "ruby", "display_name": "Ruby", "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", "created_by": "Yukihiro Matsumoto", "released": "December 21, 1995", "created_at": "2016-11-28T22:03:59Z", "updated_at": "2017-10-30T18:16:32Z", "featured": true, "curated": true, "score": 1 }, { "name": "rails", "display_name": "Rails", "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", "created_by": "David Heinemeier Hansson", "released": "December 13 2005", "created_at": "2016-12-09T17:03:50Z", "updated_at": "2017-10-30T16:20:19Z", "featured": true, "curated": true, "score": 1 }, { "name": "python", "display_name": "Python", "short_description": "Python is a dynamically typed programming language.", "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", "created_by": "Guido van Rossum", "released": "February 20, 1991", "created_at": "2016-12-07T00:07:02Z", "updated_at": "2017-10-27T22:45:43Z", "featured": true, "curated": true, "score": 1 }, { "name": "jekyll", "display_name": "Jekyll", "short_description": "Jekyll is a simple, blog-aware static site generator.", "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", "created_by": "Tom Preston-Werner", "released": "2008", "created_at": "2016-12-16T21:53:08Z", "updated_at": "2017-10-27T19:00:24Z", "featured": true, "curated": true, "score": 1 }, { "name": "sass", "display_name": "Sass", "short_description": "Sass is a stable extension to classic CSS.", "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", "released": "November 28, 2006", "created_at": "2016-12-16T21:53:45Z", "updated_at": "2018-01-16T16:30:40Z", "featured": true, "curated": true, "score": 1 }, { "name": "homebrew", "display_name": "Homebrew", "short_description": "Homebrew is a package manager for macOS.", "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", "created_by": "Max Howell", "released": "2009", "created_at": "2016-12-17T20:30:44Z", "updated_at": "2018-02-06T16:14:56Z", "featured": true, "curated": true, "score": 1 } ] } } } ], "previews": [], "descriptionHTML": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "search" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/search/users", "title": "Search users", "category": "search", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See \"Searching users\" for a detailed list of qualifiers.
" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "followers", "repositories", "joined" ] }, "descriptionHTML": "Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "total_count": 12, "incomplete_results": false, "items": [ { "login": "mojombo", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", "gravatar_id": "", "url": "https://api.github.com/users/mojombo", "html_url": "https://github.com/mojombo", "followers_url": "https://api.github.com/users/mojombo/followers", "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", "organizations_url": "https://api.github.com/users/mojombo/orgs", "repos_url": "https://api.github.com/users/mojombo/repos", "received_events_url": "https://api.github.com/users/mojombo/received_events", "type": "User", "score": 1, "following_url": "https://api.github.com/users/mojombo/following{/other_user}", "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", "events_url": "https://api.github.com/users/mojombo/events{/privacy}", "site_admin": true } ] } } } ], "previews": [], "descriptionHTML": "Find users via various criteria. This method returns up to 100 results per page.
\nWhen searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=tom+repos:%3E42+followers:%3E1000
This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "422", "description": "Validation failed
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "search" } ] }, "secret-scanning": { "secret-scanning": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/enterprises/{enterprise}/secret-scanning/alerts", "title": "List secret scanning alerts for an enterprise", "category": "secret-scanning", "parameters": [ { "name": "enterprise", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "resolved" ] }, "descriptionHTML": "Set to open or resolved to only list secret scanning alerts in a specific state.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).
" }, { "name": "resolution", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
Results per page (max 100)
" }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "enterprise": "ENTERPRISE" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 2, "created_at": "2020-11-06T18:48:51Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", "state": "resolved", "resolution": "false_positive", "resolved_at": "2020-11-07T02:47:13Z", "resolved_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "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 }, "secret_type": "adafruit_io_key", "secret_type_display_name": "Adafruit IO Key", "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", "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": false, "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-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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, "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 } } }, { "number": 1, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", "html_url": "https://github.com/owner/repo/security/secret-scanning/1", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", "state": "open", "resolution": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "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": false, "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-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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, "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 } } } ] } } ], "previews": [], "descriptionHTML": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/secret-scanning/alerts", "title": "List secret scanning alerts for an organization", "category": "secret-scanning", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "resolved" ] }, "descriptionHTML": "Set to open or resolved to only list secret scanning alerts in a specific state.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).
" }, { "name": "resolution", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 2, "created_at": "2020-11-06T18:48:51Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", "state": "resolved", "resolution": "false_positive", "resolved_at": "2020-11-07T02:47:13Z", "resolved_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "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 }, "secret_type": "adafruit_io_key", "secret_type_display_name": "Adafruit IO Key", "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", "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": false, "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-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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, "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 } } }, { "number": 1, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", "html_url": "https://github.com/owner/repo/security/secret-scanning/1", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", "state": "open", "resolution": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "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": false, "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-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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, "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 } } } ] } } ], "previews": [], "descriptionHTML": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts", "title": "List secret scanning alerts for a repository", "category": "secret-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "open", "resolved" ] }, "descriptionHTML": "Set to open or resolved to only list secret scanning alerts in a specific state.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).
" }, { "name": "resolution", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "number": 2, "created_at": "2020-11-06T18:48:51Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", "state": "resolved", "resolution": "false_positive", "resolved_at": "2020-11-07T02:47:13Z", "resolved_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "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 }, "secret_type": "adafruit_io_key", "secret_type_display_name": "Adafruit IO Key", "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX" }, { "number": 1, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", "html_url": "https://github.com/owner/repo/security/secret-scanning/1", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations", "state": "open", "resolution": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" } ] } } ], "previews": [], "descriptionHTML": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Repository is public or secret scanning is disabled for the repository
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "title": "Get a secret scanning alert", "category": "secret-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "alert_number", "in": "path", "required": true, "schema": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "descriptionHTML": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Response
", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", "state": "open", "resolution": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" } } } ], "previews": [], "descriptionHTML": "Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "title": "Update a secret scanning alert", "category": "secret-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "alert_number", "in": "path", "required": true, "schema": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "descriptionHTML": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Required. Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert. Can be one of false_positive, wont_fix, revoked, or used_in_tests.
Response
", "example": { "number": 42, "created_at": "2020-11-06T18:18:30Z", "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", "state": "resolved", "resolution": "used_in_tests", "resolved_at": "2020-11-16T22:42:07Z", "resolved_by": { "login": "monalisa", "id": 2, "node_id": "MDQ6VXNlcjI=", "avatar_url": "https://alambic.github.com/avatars/u/2?", "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 }, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" } } } ], "previews": [], "descriptionHTML": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" }, { "httpStatusCode": "422", "description": "State does not match the resolution
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", "title": "List locations for a secret scanning alert", "category": "secret-scanning", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "alert_number", "in": "path", "required": true, "schema": { "type": "integer", "description": "The security alert number.", "readOnly": true }, "descriptionHTML": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Page number of the results to fetch.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "alert_number": "ALERT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "type": "commit", "details": { "path": "/example/secrets.txt", "start_line": 1, "end_line": 1, "start_column": 1, "end_column": 64, "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" } }, { "type": "commit", "details": { "path": "/example/secrets.txt", "start_line": 5, "end_line": 5, "start_column": 1, "end_column": 64, "blob_sha": "9def38117ab2d8355b982429aa924e268b4b0065", "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065", "commit_sha": "588483b99a46342501d99e3f10630cfc1219ea32", "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32" } }, { "type": "commit", "details": { "path": "/example/secrets.txt", "start_line": 12, "end_line": 12, "start_column": 1, "end_column": 64, "blob_sha": "0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf", "commit_sha": "9def38117ab2d8355b982429aa924e268b4b0065", "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065" } } ] } } ], "previews": [], "descriptionHTML": "Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
OK
" }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" }, { "httpStatusCode": "503", "description": "Service unavailable
" } ], "subcategory": "secret-scanning" } ] }, "teams": { "teams": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams", "title": "List teams", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null } ] } } ], "previews": [], "descriptionHTML": "Lists all teams in an organization that are visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams", "title": "Create a team", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The name of the team.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the team.", "childParamsGroups": [] }, { "type": "string", "description": "The description of the team.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "The description of the team.", "childParamsGroups": [] }, { "type": "array of strings", "description": "List GitHub IDs for organization members who will become team maintainers.
", "items": { "type": "string" }, "name": "maintainers", "in": "body", "rawType": "array", "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", "childParamsGroups": [] }, { "type": "array of strings", "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.
", "items": { "type": "string" }, "name": "repo_names", "in": "body", "rawType": "array", "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "childParamsGroups": [] }, { "type": "string", "description": "The level of privacy this team should have. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nDefault: secret
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
The ID of a team to set as the parent team.
", "name": "parent_team_id", "in": "body", "rawType": "integer", "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "Justice League", "description": "A great team", "permission": "push", "privacy": "closed" }, "parameters": { "org": "ORG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "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", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } } } } ], "previews": [], "descriptionHTML": "To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}", "title": "Get a team by name", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "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", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } } } } ], "previews": [], "descriptionHTML": "Gets a team using the team's slug. GitHub generates the slug from the team name.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}", "title": "Update a team", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [ { "type": "string", "description": "The name of the team.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the team.", "childParamsGroups": [] }, { "type": "string", "description": "The description of the team.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "The description of the team.", "childParamsGroups": [] }, { "type": "string", "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.
The ID of a team to set as the parent team.
", "name": "parent_team_id", "in": "body", "rawType": [ "integer", "null" ], "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", "description": "new team description", "privacy": "closed" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "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", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } } } } ], "previews": [], "descriptionHTML": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
Created
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}", "title": "Delete a team", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "To delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
\nNote: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects", "title": "List team projects", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z", "organization_permission": "write", "private": false, "permissions": { "read": true, "write": true, "admin": false } } ] } } ], "previews": [], "descriptionHTML": "Lists the organization projects for a team.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
OK
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "title": "Check team permissions for a project", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z", "organization_permission": "write", "private": false, "permissions": { "read": true, "write": true, "admin": false } } } } ], "previews": [], "descriptionHTML": "Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
OK
" }, { "httpStatusCode": "404", "description": "Not Found if project is not managed by this team
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "title": "Add or update team project permissions", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The permission to grant to the team for this project. Can be one of:
\n* read - team members can read, but not write to or administer this project.
\n* write - team members can read and write, but not administer this project.
\n* admin - team members can read, write and administer this project.
\nDefault: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Response
" } } ], "previews": [], "descriptionHTML": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden if the project is not owned by the organization
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "title": "Remove a project from a team", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos", "title": "List team repositories", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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": false, "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": null } ] } } ], "previews": [], "descriptionHTML": "Lists a team's repositories visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
OK
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "title": "Check team permissions for a repository", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "alternative-response-with-repository-permissions", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Alternative response with repository permissions
", "example": { "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": false, "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, "maintain": false, "push": false, "triage": false, "pull": true }, "role_name": "read", "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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": { "pull": true, "triage": false, "push": false, "maintain": false, "admin": false }, "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 }, "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } } } ], "previews": [], "descriptionHTML": "Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
Alternative response with repository permissions
" }, { "httpStatusCode": "204", "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header.
" }, { "httpStatusCode": "404", "description": "Not Found if team does not have permission for the repository
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "title": "Add or update team repository permissions", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The permission to grant the team on this repository. Can be one of:
\n* pull - team members can pull, but not push to or administer this repository.
\n* push - team members can pull and push, but not administer this repository.
\n* admin - team members can pull, push and administer this repository.
\n* maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations.
\n* triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.
\n* custom repository role name - A custom repository role if the owning organization has defined any.
If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
Response
" } } ], "previews": [], "descriptionHTML": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "title": "Remove a repository from a team", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
\nNote: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/teams", "title": "List child teams", "category": "teams", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if child teams exist
", "example": [ { "id": 2, "node_id": "MDQ6VGVhbTI=", "url": "https://api.github.com/teams/2", "name": "Original Roster", "slug": "original-roster", "description": "Started it all.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/2/members{/member}", "repositories_url": "https://api.github.com/teams/2/repos", "parent": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" }, "html_url": "https://github.com/orgs/rails/teams/core" } ] } } ], "previews": [], "descriptionHTML": "Lists the child teams of the team specified by {team_slug}.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
if child teams exist
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}", "title": "Get a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "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", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/teams/{team_id}", "title": "Update a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The name of the team.
", "name": "name", "in": "body", "rawType": "string", "rawDescription": "The name of the team.", "childParamsGroups": [] }, { "type": "string", "description": "The description of the team.
", "name": "description", "in": "body", "rawType": "string", "rawDescription": "The description of the team.", "childParamsGroups": [] }, { "type": "string", "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.
The ID of a team to set as the parent team.
", "name": "parent_team_id", "in": "body", "rawType": [ "integer", "null" ], "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", "description": "new team description", "privacy": "closed" }, "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response when the updated information already exists
", "example": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "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", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } } } }, { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "new team name", "description": "new team description", "privacy": "closed" }, "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "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", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
Response when the updated information already exists
" }, { "httpStatusCode": "201", "description": "Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}", "title": "Delete a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/projects", "title": "List team projects (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z", "organization_permission": "write", "private": false, "permissions": { "read": true, "write": true, "admin": false } } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/projects/{project_id}", "title": "Check team permissions for a project (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "owner_url": "https://api.github.com/orgs/octocat", "url": "https://api.github.com/projects/1002605", "html_url": "https://github.com/orgs/api-playground/projects/1", "columns_url": "https://api.github.com/projects/1002605/columns", "id": 1002605, "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "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 }, "created_at": "2011-04-11T20:09:31Z", "updated_at": "2014-03-04T18:58:10Z", "organization_permission": "write", "private": false, "permissions": { "read": true, "write": true, "admin": false } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
OK
" }, { "httpStatusCode": "404", "description": "Not Found if project is not managed by this team
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/teams/{team_id}/projects/{project_id}", "title": "Add or update team project permissions (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The permission to grant to the team for this project. Can be one of:
\n* read - team members can read, but not write to or administer this project.
\n* write - team members can read and write, but not administer this project.
\n* admin - team members can read, write and administer this project.
\nDefault: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden if the project is not owned by the organization
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/projects/{project_id}", "title": "Remove a project from a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "project_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/repos", "title": "List team repositories (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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": false, "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": null } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", "title": "Check team permissions for a repository (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "alternative-response-with-extra-repository-information", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Alternative response with extra repository information
", "example": { "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": false, "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, "maintain": false, "push": false, "triage": false, "pull": true }, "role_name": "read", "allow_rebase_merge": true, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World-Template", "full_name": "octocat/Hello-World-Template", "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-Template", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World-Template", "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World-Template.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World-Template.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World-Template.git", "mirror_url": "git:git.example.com/octocat/Hello-World-Template", "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World-Template", "homepage": "https://github.com", "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": { "pull": true, "triage": false, "push": false, "maintain": false, "admin": false }, "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 }, "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://api.github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } } } ], "previews": [], "descriptionHTML": "Note: Repositories inherited through a parent team will also be checked.
\nDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Alternative response with extra repository information
" }, { "httpStatusCode": "204", "description": "Response if repository is managed by this team
" }, { "httpStatusCode": "404", "description": "Not Found if repository is not managed by this team
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", "title": "Add or update team repository permissions (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The permission to grant the team on this repository. Can be one of:
\n* pull - team members can pull, but not push to or administer this repository.
\n* push - team members can pull and push, but not administer this repository.
\n* admin - team members can pull, push and administer this repository.
If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.
Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"Add or update team repository permissions\" endpoint.
\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", "title": "Remove a repository from a team (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/teams", "title": "List child teams (Legacy)", "category": "teams", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "if child teams exist
", "example": [ { "id": 2, "node_id": "MDQ6VGVhbTI=", "url": "https://api.github.com/teams/2", "name": "Original Roster", "slug": "original-roster", "description": "Started it all.", "privacy": "closed", "permission": "admin", "members_url": "https://api.github.com/teams/2/members{/member}", "repositories_url": "https://api.github.com/teams/2/repos", "parent": { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos" }, "html_url": "https://github.com/orgs/rails/teams/core" } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
if child teams exist
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "teams" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/teams", "title": "List teams for the authenticated user", "category": "teams", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null, "members_count": 3, "repos_count": 10, "created_at": "2017-07-14T16:53:42Z", "updated_at": "2017-08-17T12:37:15Z", "organization": { "login": "github", "id": 1, "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", "url": "https://api.github.com/orgs/github", "repos_url": "https://api.github.com/orgs/github/repos", "events_url": "https://api.github.com/orgs/github/events", "hooks_url": "https://api.github.com/orgs/github/hooks", "issues_url": "https://api.github.com/orgs/github/issues", "members_url": "https://api.github.com/orgs/github/members{/member}", "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "description": "A great organization", "name": "github", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "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", "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" } } ] } } ], "previews": [], "descriptionHTML": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "teams" } ], "discussion-comments": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "title": "List discussion comments", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "descriptionHTML": "One of asc (ascending) or desc (descending).
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "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 }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } ] } } ], "previews": [], "descriptionHTML": "List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "title": "Create a discussion comment", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The discussion comment's body text.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The discussion comment's body text.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "title": "Get a discussion comment", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "title": "Update a discussion comment", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The discussion comment's body text.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The discussion comment's body text.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Do you like pineapples?", "body_html": "Do you like pineapples?
", "body_version": "e6907b24d9c93cc0c5024a7af5888116", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": "2018-01-26T18:22:20Z", "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-26T18:22:20Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "title": "Delete a discussion comment", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", "title": "List discussion comments (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "descriptionHTML": "One of asc (ascending) or desc (descending).
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "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 }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments", "title": "Create a discussion comment (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The discussion comment's body text.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The discussion comment's body text.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like apples?" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "title": "Get a discussion comment (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Do you like apples?", "body_html": "Do you like apples?
", "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": null, "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-15T23:53:58Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "title": "Update a discussion comment (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The discussion comment's body text.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The discussion comment's body text.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "body": "Do you like pineapples?" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Do you like pineapples?", "body_html": "Do you like pineapples?
", "body_version": "e6907b24d9c93cc0c5024a7af5888116", "created_at": "2018-01-15T23:53:58Z", "last_edited_at": "2018-01-26T18:22:20Z", "discussion_url": "https://api.github.com/teams/2403582/discussions/1", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", "number": 1, "updated_at": "2018-01-26T18:22:20Z", "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", "reactions": { "url": "https://api.github.com/teams/2403582/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "title": "Delete a discussion comment (Legacy)", "category": "teams", "subcategory": "discussion-comments", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "comment_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER", "comment_number": "COMMENT_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
No Content
" } ] } ], "discussions": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", "title": "List discussions", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "descriptionHTML": "One of asc (ascending) or desc (descending).
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" }, { "name": "pinned", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "Pinned discussions only filter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "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 }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } ] } } ], "previews": [], "descriptionHTML": "List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", "title": "Create a discussion", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [ { "type": "string", "description": "Required. The discussion post's title.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "The discussion post's title.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The discussion post's body text.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The discussion post's body text.", "childParamsGroups": [] }, { "type": "boolean", "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.
Response
", "example": { "author": { "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 }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "title": "Get a discussion", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "title": "Update a discussion", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The discussion post's title.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "The discussion post's title.", "childParamsGroups": [] }, { "type": "string", "description": "The discussion post's body text.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The discussion post's body text.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 1, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": "2018-01-26T18:22:20Z", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Welcome to our first team post", "updated_at": "2018-01-26T18:22:20Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "title": "Delete a discussion", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions", "title": "List discussions (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "direction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "descriptionHTML": "One of asc (ascending) or desc (descending).
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "author": { "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 }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/teams/{team_id}/discussions", "title": "Create a discussion (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Required. The discussion post's title.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "The discussion post's title.", "childParamsGroups": [] }, { "type": "string", "description": "Required. The discussion post's body text.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The discussion post's body text.", "childParamsGroups": [] }, { "type": "boolean", "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.
Response
", "example": { "author": { "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 }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", "title": "Get a discussion (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 0, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": null, "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Our first team post", "updated_at": "2018-01-25T18:56:31Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", "title": "Update a discussion (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The discussion post's title.
", "name": "title", "in": "body", "rawType": "string", "rawDescription": "The discussion post's title.", "childParamsGroups": [] }, { "type": "string", "description": "The discussion post's body text.
", "name": "body", "in": "body", "rawType": "string", "rawDescription": "The discussion post's body text.", "childParamsGroups": [] } ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "title": "Welcome to our first team post" }, "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "author": { "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 }, "body": "Hi! This is an area for us to collaborate as a team.", "body_html": "Hi! This is an area for us to collaborate as a team
", "body_version": "0d495416a700fb06133c612575d92bfb", "comments_count": 1, "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", "created_at": "2018-01-25T18:56:31Z", "last_edited_at": "2018-01-26T18:22:20Z", "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", "number": 1, "pinned": false, "private": false, "team_url": "https://api.github.com/teams/2343027", "title": "Welcome to our first team post", "updated_at": "2018-01-26T18:22:20Z", "url": "https://api.github.com/teams/2343027/discussions/1", "reactions": { "url": "https://api.github.com/teams/2343027/discussions/1/reactions", "total_count": 5, "+1": 3, "-1": 1, "laugh": 0, "confused": 0, "heart": 1, "hooray": 0, "eyes": 1, "rocket": 1 } } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/discussions/{discussion_number}", "title": "Delete a discussion (Legacy)", "category": "teams", "subcategory": "discussions", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "discussion_number": "DISCUSSION_NUMBER" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
No Content
" } ] } ], "external-groups": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/external-group/{group_id}", "title": "Get an external group", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "group_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "group_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "group_id": "GROUP_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00", "teams": [ { "team_id": 1, "team_name": "team-test" }, { "team_id": 2, "team_name": "team-test2" } ], "members": [ { "member_id": 1, "member_login": "mona-lisa_eocsaxrs", "member_name": "Mona Lisa", "member_email": "mona_lisa@github.com" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "octo_lisa@github.com" } ] } } } ], "previews": [], "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/external-groups", "title": "List external groups in an organization", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer" }, "descriptionHTML": "Page token
" }, { "name": "display_name", "in": "query", "schema": { "type": "string" }, "descriptionHTML": "Limits the list to groups containing the text in the group name
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00" }, { "group_id": "456", "group_name": "Octocat docs members", "updated_at": "2021-03-24T11:31:04-06:00" } ] } } } ], "previews": [], "descriptionHTML": "Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", "title": "List a connection between an external group and a team", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00" }, { "group_id": "456", "group_name": "Octocat docs members", "updated_at": "2021-03-24T11:31:04-06:00" } ] } } } ], "previews": [], "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", "title": "Update the connection between an external group and a team", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [ { "type": "integer", "description": "Required. External Group Id
", "examples": [ 1 ], "name": "group_id", "in": "body", "rawType": "integer", "rawDescription": "External Group Id", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "group_id": 123 }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "group_id": "123", "group_name": "Octocat admins", "updated_at": "2021-01-24T11:31:04-06:00", "teams": [ { "team_id": 1, "team_name": "team-test" }, { "team_id": 2, "team_name": "team-test2" } ], "members": [ { "member_id": 1, "member_login": "mona-lisa_eocsaxrs", "member_name": "Mona Lisa", "member_email": "mona_lisa@github.com" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "octo_lisa@github.com" } ] } } } ], "previews": [], "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/external-groups", "title": "Remove the connection between an external group and a team", "category": "teams", "subcategory": "external-groups", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } ] } ], "members": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/invitations", "title": "List pending team invitations", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } ] } } ], "previews": [], "descriptionHTML": "The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/invitations.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/members", "title": "List team members", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "member", "maintainer", "all" ], "default": "all" }, "descriptionHTML": "Filters members returned by their role in the team. Can be one of:
\n* member - normal members of the team.
\n* maintainer - team maintainers.
\n* all - all members of the team.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "title": "Get team membership for a user", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if user is a team maintainer
", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", "state": "active" } } } ], "previews": [], "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
OK
" }, { "httpStatusCode": "404", "description": "if user has no team membership
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "title": "Add or update team membership for a user", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The role that this user should have in the team. Can be one of:
\n* member - a normal member of the team.
\n* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.
Response if user's membership with team is now pending
", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", "state": "pending" } } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
OK
" }, { "httpStatusCode": "403", "description": "Forbidden if team synchronization is set up
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if you attempt to add an organization to a team
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "title": "Remove team membership for a user", "category": "teams", "subcategory": "members", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden if team synchronization is set up
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/invitations", "title": "List pending team invitations (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "login": "monalisa", "node_id": "MDQ6VXNlcjE=", "email": "octocat@github.com", "role": "direct_member", "created_at": "2016-11-30T06:46:10-08:00", "failed_at": "", "failed_reason": "", "inviter": { "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/other_user_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/other_user", "html_url": "https://github.com/other_user", "followers_url": "https://api.github.com/users/other_user/followers", "following_url": "https://api.github.com/users/other_user/following{/other_user}", "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", "organizations_url": "https://api.github.com/users/other_user/orgs", "repos_url": "https://api.github.com/users/other_user/repos", "events_url": "https://api.github.com/users/other_user/events{/privacy}", "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, "team_count": 2, "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams" } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations endpoint.
The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/members", "title": "List team members (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "member", "maintainer", "all" ], "default": "all" }, "descriptionHTML": "Filters members returned by their role in the team. Can be one of:
\n* member - normal members of the team.
\n* maintainer - team maintainers.
\n* all - all members of the team.
Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/members/{username}", "title": "Get team member (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "if user is a member
" } } ], "previews": [], "descriptionHTML": "The \"Get team member\" endpoint (described below) is deprecated.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "204", "description": "if user is a member
" }, { "httpStatusCode": "404", "description": "if user is not a member
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/teams/{team_id}/members/{username}", "title": "Add team member (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
No Content
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Not Found if team synchronization is set up
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/members/{username}", "title": "Remove team member (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "The \"Remove team member\" endpoint (described below) is deprecated.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Not Found if team synchronization is setup
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/memberships/{username}", "title": "Get team membership for a user (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response if user is a team maintainer
", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "maintainer", "state": "active" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe response contains the state of the membership and the member's role.
The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/teams/{team_id}/memberships/{username}", "title": "Add or update team membership for a user (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The role that this user should have in the team. Can be one of:
\n* member - a normal member of the team.
\n* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.
Response if user's membership with team is now pending
", "example": { "url": "https://api.github.com/teams/1/memberships/octocat", "role": "member", "state": "pending" } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden if team synchronization is set up
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Unprocessable Entity if you attempt to add an organization to a team
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/teams/{team_id}/memberships/{username}", "title": "Remove team membership for a user (Legacy)", "category": "teams", "subcategory": "members", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID", "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nNote: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "403", "description": "if team synchronization is set up
" } ] } ], "team-sync": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/team-sync/groups", "title": "List IdP groups for an organization", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "string" }, "descriptionHTML": "Page token
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", "group_description": "The people who make your octoworld come to life." } ] } } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups available in an organization. You can limit your page results using the per_page parameter. GitHub generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "title": "List IdP groups for a team", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", "group_description": "The people who make your octoworld come to life." } ] } } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups connected to a team on GitHub.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "title": "Create or update IdP group connections", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "org", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "team_slug", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "team_slug parameter
" } ], "bodyParameters": [ { "type": "array of objects", "description": "The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
Required. ID of the IdP group.
", "name": "group_id", "in": "body", "rawType": "string", "rawDescription": "ID of the IdP group.", "childParamsGroups": [] }, "group_name": { "type": "string", "description": "Required. Name of the IdP group.
", "name": "group_name", "in": "body", "rawType": "string", "rawDescription": "Name of the IdP group.", "childParamsGroups": [] }, "group_description": { "type": "string", "description": "Required. Description of the IdP group.
", "name": "group_description", "in": "body", "rawType": "string", "rawDescription": "Description of the IdP group.", "childParamsGroups": [] } }, "required": [ "group_id", "group_name", "group_description" ] }, "name": "groups", "in": "body", "rawType": "array", "rawDescription": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", "childParamsGroups": [ { "parentName": "groups", "parentType": "items", "id": "groups-items", "params": [ { "type": "string", "description": "Required. ID of the IdP group.
", "name": "group_id", "in": "body", "rawType": "string", "rawDescription": "ID of the IdP group.", "childParamsGroups": [] }, { "type": "string", "description": "Required. Name of the IdP group.
", "name": "group_name", "in": "body", "rawType": "string", "rawDescription": "Name of the IdP group.", "childParamsGroups": [] }, { "type": "string", "description": "Required. Description of the IdP group.
", "name": "group_description", "in": "body", "rawType": "string", "rawDescription": "Description of the IdP group.", "childParamsGroups": [] } ] } ] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "string" } ] }, "parameters": { "org": "ORG", "team_slug": "TEAM_SLUG" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", "group_description": "The people who make your octoworld come to life." } ] } } } ], "previews": [], "descriptionHTML": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/teams/{team_id}/team-sync/group-mappings", "title": "List IdP groups for a team (Legacy)", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." }, { "group_id": "456", "group_name": "Octocat docs members", "group_description": "The people who make your octoworld come to life." } ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nList IdP groups connected to a team on GitHub.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/teams/{team_id}/team-sync/group-mappings", "title": "Create or update IdP group connections (Legacy)", "category": "teams", "subcategory": "team-sync", "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "array of objects", "description": "Required. The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
Required. ID of the IdP group.
", "name": "group_id", "in": "body", "rawType": "string", "rawDescription": "ID of the IdP group.", "childParamsGroups": [] }, "group_name": { "type": "string", "description": "Required. Name of the IdP group.
", "name": "group_name", "in": "body", "rawType": "string", "rawDescription": "Name of the IdP group.", "childParamsGroups": [] }, "group_description": { "type": "string", "description": "Required. Description of the IdP group.
", "name": "group_description", "in": "body", "rawType": "string", "rawDescription": "Description of the IdP group.", "childParamsGroups": [] }, "id": { "type": "string", "examples": [ "\"caceab43fc9ffa20081c\"" ], "name": "id", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, "name": { "type": "string", "examples": [ "\"external-team-6c13e7288ef7\"" ], "name": "name", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, "description": { "type": "string", "examples": [ "\"moar cheese pleese\"" ], "name": "description", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } }, "required": [ "group_id", "group_name", "group_description" ] }, "name": "groups", "in": "body", "rawType": "array", "rawDescription": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", "childParamsGroups": [ { "parentName": "groups", "parentType": "items", "id": "groups-items", "params": [ { "type": "string", "description": "Required. ID of the IdP group.
", "name": "group_id", "in": "body", "rawType": "string", "rawDescription": "ID of the IdP group.", "childParamsGroups": [] }, { "type": "string", "description": "Required. Name of the IdP group.
", "name": "group_name", "in": "body", "rawType": "string", "rawDescription": "Name of the IdP group.", "childParamsGroups": [] }, { "type": "string", "description": "Required. Description of the IdP group.
", "name": "group_description", "in": "body", "rawType": "string", "rawDescription": "Description of the IdP group.", "childParamsGroups": [] }, { "type": "string", "examples": [ "\"caceab43fc9ffa20081c\"" ], "name": "id", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, { "type": "string", "examples": [ "\"external-team-6c13e7288ef7\"" ], "name": "name", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] }, { "type": "string", "examples": [ "\"moar cheese pleese\"" ], "name": "description", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ] } ] }, { "type": "string", "examples": [ "\"I am not a timestamp\"" ], "name": "synced_at", "in": "body", "rawType": "string", "description": "", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "description": "The people who configure your octoworld.", "group_description": "string" } ] }, "parameters": { "team_id": "TEAM_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "groups": [ { "group_id": "123", "group_name": "Octocat admins", "group_description": "The people who configure your octoworld." } ] } } } ], "previews": [], "descriptionHTML": "Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create or update IdP group connections endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
OK
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ] }, "users": { "users": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user", "title": "Get the authenticated user", "category": "users", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "response-with-public-and-private-profile-information", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response with public and private profile information
", "example": { "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": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z", "private_gists": 81, "total_private_repos": 100, "owned_private_repos": 100, "disk_usage": 10000, "collaborators": 8, "two_factor_authentication": true, "plan": { "name": "Medium", "space": 400, "private_repos": 20, "collaborators": 0 } } } }, { "key": "response-with-public-profile-information", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response with public profile information
", "example": { "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": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z" } } } ], "previews": [], "descriptionHTML": "If the authenticated user is authenticated through basic authentication or OAuth with the user scope, then the response lists public and private profile information.
If the authenticated user is authenticated through OAuth without the user scope, then the response lists only public profile information.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ], "subcategory": "users" }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user", "title": "Update the authenticated user", "category": "users", "parameters": [], "bodyParameters": [ { "description": "The new name of the user.
", "type": "string", "examples": [ "Omar Jahandar" ], "name": "name", "in": "body", "rawType": "string", "rawDescription": "The new name of the user.", "childParamsGroups": [] }, { "description": "The publicly visible email address of the user.
", "type": "string", "examples": [ "omar@example.com" ], "name": "email", "in": "body", "rawType": "string", "rawDescription": "The publicly visible email address of the user.", "childParamsGroups": [] }, { "description": "The new blog URL of the user.
", "type": "string", "examples": [ "blog.example.com" ], "name": "blog", "in": "body", "rawType": "string", "rawDescription": "The new blog URL of the user.", "childParamsGroups": [] }, { "description": "The new Twitter username of the user.
", "type": "string or null", "examples": [ "therealomarj" ], "name": "twitter_username", "in": "body", "rawType": [ "string", "null" ], "rawDescription": "The new Twitter username of the user.", "childParamsGroups": [] }, { "description": "The new company of the user.
", "type": "string", "examples": [ "Acme corporation" ], "name": "company", "in": "body", "rawType": "string", "rawDescription": "The new company of the user.", "childParamsGroups": [] }, { "description": "The new location of the user.
", "type": "string", "examples": [ "Berlin, Germany" ], "name": "location", "in": "body", "rawType": "string", "rawDescription": "The new location of the user.", "childParamsGroups": [] }, { "description": "The new hiring availability of the user.
", "type": "boolean", "name": "hireable", "in": "body", "rawType": "boolean", "rawDescription": "The new hiring availability of the user.", "childParamsGroups": [] }, { "description": "The new short biography of the user.
", "type": "string", "name": "bio", "in": "body", "rawType": "string", "rawDescription": "The new short biography of the user.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z", "private_gists": 81, "total_private_repos": 100, "owned_private_repos": 100, "disk_usage": 10000, "collaborators": 8, "two_factor_authentication": true, "plan": { "name": "Medium", "space": 400, "private_repos": 20, "collaborators": 0 } } } } ], "previews": [], "descriptionHTML": "Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "users" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users", "title": "List users", "category": "users", "parameters": [ { "name": "since", "in": "query", "required": false, "schema": { "type": "integer" }, "descriptionHTML": "A user ID. Only return users with an ID greater than this ID.
" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" } ], "subcategory": "users" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}", "title": "Get a user", "category": "users", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default-response", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Default response
", "example": { "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": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z" } } }, { "key": "response-with-git-hub-plan-information", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response with GitHub plan information
", "example": { "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": "monalisa octocat", "company": "GitHub", "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", "hireable": false, "bio": "There once was...", "twitter_username": "monatheoctocat", "public_repos": 2, "public_gists": 1, "followers": 20, "following": 0, "created_at": "2008-01-14T04:33:35Z", "updated_at": "2008-01-14T04:33:35Z", "plan": { "name": "pro", "space": 976562499, "collaborators": 0, "private_repos": 9999 } } } } ], "previews": [], "descriptionHTML": "Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"Emails API\".
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ], "subcategory": "users" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/hovercard", "title": "Get contextual information for a user", "category": "users", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "subject_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "organization", "repository", "issue", "pull_request" ] }, "descriptionHTML": "Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.
Uses the ID for the subject_type you specified. Required when using subject_type.
Response
", "example": { "contexts": [ { "message": "Owns this repository", "octicon": "repo" } ] } } } ], "previews": [], "descriptionHTML": "Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:
curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ], "subcategory": "users" } ], "blocking": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/blocks", "title": "List users blocked by the authenticated user", "category": "users", "subcategory": "blocking", "parameters": [], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "List the users you've blocked on your personal account.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/blocks/{username}", "title": "Check if a user is blocked by the authenticated user", "category": "users", "subcategory": "blocking", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "If the user is blocked:
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "If the user is blocked:
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "If the user is not blocked:
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/blocks/{username}", "title": "Block a user", "category": "users", "subcategory": "blocking", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/blocks/{username}", "title": "Unblock a user", "category": "users", "subcategory": "blocking", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "emails": [ { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/user/email/visibility", "title": "Set primary email visibility for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [], "bodyParameters": [ { "description": "Required. Denotes whether an email is publicly visible.
", "type": "string", "enum": [ "public", "private" ], "name": "visibility", "in": "body", "rawType": "string", "rawDescription": "Denotes whether an email is publicly visible.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "email": "octocat@github.com", "primary": true, "verified": true, "visibility": "private" } ] } } ], "previews": [], "descriptionHTML": "Sets the visibility for your primary email addresses.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/emails", "title": "List email addresses for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "email": "octocat@github.com", "verified": true, "primary": true, "visibility": "public" } ] } } ], "previews": [], "descriptionHTML": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/emails", "title": "Add an email address for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [], "bodyParameters": [ { "description": "Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.
Response
", "example": [ { "email": "octocat@octocat.org", "primary": false, "verified": false, "visibility": "public" }, { "email": "octocat@github.com", "primary": false, "verified": false, "visibility": null }, { "email": "mona@github.com", "primary": false, "verified": false, "visibility": null } ] } } ], "previews": [], "descriptionHTML": "This endpoint is accessible with the user scope.
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/emails", "title": "Delete an email address for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [], "bodyParameters": [ { "description": "Required. Email addresses associated with the GitHub user account.
", "type": "array of strings", "items": { "type": "string", "minItems": 1, "examples": [ "username@example.com" ] }, "name": "emails", "in": "body", "rawType": "array", "rawDescription": "Email addresses associated with the GitHub user account.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This endpoint is accessible with the user scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/public_emails", "title": "List public email addresses for the authenticated user", "category": "users", "subcategory": "emails", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "email": "octocat@github.com", "verified": true, "primary": true, "visibility": "public" } ] } } ], "previews": [], "descriptionHTML": "Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ], "followers": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/followers", "title": "List followers of the authenticated user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists the people following the authenticated user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/following", "title": "List the people the authenticated user follows", "category": "users", "subcategory": "followers", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists the people who the authenticated user follows.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/following/{username}", "title": "Check if a person is followed by the authenticated user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "if the person is followed by the authenticated user
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "if the person is followed by the authenticated user
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "if the person is not followed by the authenticated user
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", "requestPath": "/user/following/{username}", "title": "Follow a user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/following/{username}", "title": "Unfollow a user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/followers", "title": "List followers of a user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists the people following the specified user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/following", "title": "List the people a user follows", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "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 } ] } } ], "previews": [], "descriptionHTML": "Lists the people who the specified user follows.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/following/{target_user}", "title": "Check if a user follows another user", "category": "users", "subcategory": "followers", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "target_user", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME", "target_user": "TARGET_USER" } }, "response": { "statusCode": "204", "description": "if the user follows the target user
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "if the user follows the target user
" }, { "httpStatusCode": "404", "description": "if the user does not follow the target user
" } ] } ], "gpg-keys": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/gpg_keys", "title": "List GPG keys for the authenticated user", "category": "users", "subcategory": "gpg-keys", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 3, "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", "emails": [ { "email": "mastahyeti@users.noreply.github.com", "verified": true } ], "subkeys": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00" } ], "can_sign": true, "can_encrypt_comms": false, "can_encrypt_storage": false, "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "raw_key": "string" } ] } } ], "previews": [], "descriptionHTML": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/gpg_keys", "title": "Create a GPG key for the authenticated user", "category": "users", "subcategory": "gpg-keys", "parameters": [], "bodyParameters": [ { "description": "Required. A GPG key in ASCII-armored format.
", "type": "string", "name": "armored_public_key", "in": "body", "rawType": "string", "rawDescription": "A GPG key in ASCII-armored format.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "id": 3, "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", "emails": [ { "email": "mastahyeti@users.noreply.github.com", "verified": true } ], "subkeys": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00" } ], "can_sign": true, "can_encrypt_comms": false, "can_encrypt_storage": false, "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" } } } ], "previews": [], "descriptionHTML": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key scope.
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/gpg_keys/{gpg_key_id}", "title": "Get a GPG key for the authenticated user", "category": "users", "subcategory": "gpg-keys", "parameters": [ { "name": "gpg_key_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "gpg_key_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "id": 3, "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", "emails": [ { "email": "mastahyeti@users.noreply.github.com", "verified": true } ], "subkeys": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00" } ], "can_sign": true, "can_encrypt_comms": false, "can_encrypt_storage": false, "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" } } } ], "previews": [], "descriptionHTML": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/gpg_keys/{gpg_key_id}", "title": "Delete a GPG key for the authenticated user", "category": "users", "subcategory": "gpg-keys", "parameters": [ { "name": "gpg_key_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "gpg_key_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "gpg_key_id": "GPG_KEY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:gpg_key scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/gpg_keys", "title": "List GPG keys for a user", "category": "users", "subcategory": "gpg-keys", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 3, "primary_key_id": 2, "key_id": "3262EFF25BA0D270", "public_key": "xsBNBFayYZ...", "emails": [ { "email": "mastahyeti@users.noreply.github.com", "verified": true } ], "subkeys": [ { "id": 4, "primary_key_id": 3, "key_id": "4A595D4C72EE49C7", "public_key": "zsBNBFayYZ...", "emails": [], "subkeys": [], "can_sign": false, "can_encrypt_comms": true, "can_encrypt_storage": true, "can_certify": false, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00" } ], "can_sign": true, "can_encrypt_comms": false, "can_encrypt_storage": false, "can_certify": true, "created_at": "2016-03-24T11:31:04-06:00", "expires_at": "2016-03-24T11:31:04-07:00", "raw_key": "string" } ] } } ], "previews": [], "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ], "keys": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/keys", "title": "List public SSH keys for the authenticated user", "category": "users", "subcategory": "keys", "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false }, { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", "id": 3, "url": "https://api.github.com/user/keys/3", "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", "created_at": "2020-07-11T21:31:57Z", "verified": false, "read_only": false } ] } } ], "previews": [], "descriptionHTML": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/user/keys", "title": "Create a public SSH key for the authenticated user", "category": "users", "subcategory": "keys", "parameters": [], "bodyParameters": [ { "description": "A descriptive name for the new key.
", "type": "string", "examples": [ "Personal MacBook Air" ], "name": "title", "in": "body", "rawType": "string", "rawDescription": "A descriptive name for the new key.", "childParamsGroups": [] }, { "description": "Required. The public SSH key to add to your GitHub account.
", "type": "string", "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", "rawType": "string", "rawDescription": "The public SSH key to add to your GitHub account.", "childParamsGroups": [] } ], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json" }, "response": { "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false } } } ], "previews": [], "descriptionHTML": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key scope.
Created
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/user/keys/{key_id}", "title": "Get a public SSH key for the authenticated user", "category": "users", "subcategory": "keys", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "key_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://api.github.com/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false } } } ], "previews": [], "descriptionHTML": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.
OK
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/user/keys/{key_id}", "title": "Delete a public SSH key for the authenticated user", "category": "users", "subcategory": "keys", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "key_id parameter
" } ], "bodyParameters": [], "enabledForGitHubApps": false, "codeExamples": [ { "key": "204", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "key_id": "KEY_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.
No Content
" }, { "httpStatusCode": "304", "description": "Not modified
" }, { "httpStatusCode": "401", "description": "Requires authentication
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/users/{username}/keys", "title": "List public keys for a user", "category": "users", "subcategory": "keys", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "username": "USERNAME" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "id": 1, "key": "ssh-rsa AAA..." } ] } } ], "previews": [], "descriptionHTML": "Lists the verified public SSH keys for a user. This is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } ] } ] }, "webhooks": { "repo-config": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", "title": "Get a webhook configuration for a repository", "category": "webhooks", "subcategory": "repo-config", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } ], "previews": [], "descriptionHTML": "Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"
Access tokens must have the read:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:read permission.
OK
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/config", "title": "Update a webhook configuration for a repository", "category": "webhooks", "subcategory": "repo-config", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Response
", "example": { "content_type": "json", "insecure_ssl": "0", "secret": "********", "url": "https://example.com/webhook" } } } ], "previews": [], "descriptionHTML": "Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"
Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.
OK
" } ] } ], "repo-deliveries": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries", "title": "List deliveries for a repository webhook", "category": "webhooks", "subcategory": "repo-deliveries", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "descriptionHTML": "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.
Response
", "example": [ { "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 }, { "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 } ] } } ], "previews": [], "descriptionHTML": "Returns a list of webhook deliveries for a webhook configured in a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", "title": "Get a delivery for a repository webhook", "category": "webhooks", "subcategory": "repo-deliveries", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID", "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "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", "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" } } } } ], "previews": [], "descriptionHTML": "Returns a delivery for a webhook configured in a repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", "title": "Redeliver a delivery for a repository webhook", "category": "webhooks", "subcategory": "repo-deliveries", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" }, { "name": "delivery_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID", "delivery_id": "DELIVERY_ID" } }, "response": { "statusCode": "202", "description": "Accepted
" } } ], "previews": [], "descriptionHTML": "Redeliver a webhook delivery for a webhook configured in a repository.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" }, { "httpStatusCode": "400", "description": "Bad Request
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] } ], "repos": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks", "title": "List repository webhooks", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 30 }, "descriptionHTML": "Results per page (max 100)
" }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "descriptionHTML": "Page number of the results to fetch.
" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": [ { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } } ] } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks", "title": "Create a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "string", "description": "Use web to create a webhook. Default: web. This parameter only accepts the value web.
Key/value pairs to provide settings for this webhook. These are defined below.
", "properties": { "url": { "type": "string", "description": "The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Determines what events the hook is triggered for.
", "default": [ "push" ], "items": { "type": "string" }, "name": "events", "in": "body", "rawType": "array", "rawDescription": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", "childParamsGroups": [] }, { "type": "boolean", "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", "example": { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } } } } ], "previews": [], "descriptionHTML": "Repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can\nshare the same config as long as those webhooks do not have any events that overlap.
Created
" }, { "httpStatusCode": "403", "description": "Forbidden
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", "title": "Get a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "Response
", "example": { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } } } } ], "previews": [], "descriptionHTML": "Returns a webhook configured in a repository. To get only the webhook config properties, see \"Get a webhook configuration for a repository.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "patch", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", "title": "Update a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [ { "type": "object", "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "properties": { "url": { "type": "string", "description": "Required. The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, "content_type": { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Required. The URL to which the payloads will be delivered.
", "format": "uri", "examples": [ "https://example.com/webhook" ], "name": "url", "in": "body", "rawType": "string", "rawDescription": "The URL to which the payloads will be delivered.", "childParamsGroups": [] }, { "type": "string", "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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.
Determines what events the hook is triggered for. This replaces the entire array of events.
", "default": [ "push" ], "items": { "type": "string" }, "name": "events", "in": "body", "rawType": "array", "rawDescription": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", "childParamsGroups": [] }, { "type": "array of strings", "description": "Determines a list of events to be added to the list of events that the Hook triggers for.
", "items": { "type": "string" }, "name": "add_events", "in": "body", "rawType": "array", "rawDescription": "Determines a list of events to be added to the list of events that the Hook triggers for.", "childParamsGroups": [] }, { "type": "array of strings", "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.
", "items": { "type": "string" }, "name": "remove_events", "in": "body", "rawType": "array", "rawDescription": "Determines a list of events to be removed from the list of events that the Hook triggers for.", "childParamsGroups": [] }, { "type": "boolean", "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.
Response
", "example": { "type": "Repository", "id": 12345678, "name": "web", "active": true, "events": [ "push", "pull_request" ], "config": { "content_type": "json", "insecure_ssl": "0", "url": "https://example.com/webhook" }, "updated_at": "2019-06-03T00:57:16Z", "created_at": "2019-06-03T00:57:16Z", "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", "last_response": { "code": null, "status": "unused", "message": null } } } } ], "previews": [], "descriptionHTML": "Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"
OK
" }, { "httpStatusCode": "404", "description": "Resource not found
" }, { "httpStatusCode": "422", "description": "Validation failed
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}", "title": "Delete a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "descriptionHTML": "", "previews": [], "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", "title": "Ping a repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", "title": "Test the push repository webhook", "category": "webhooks", "subcategory": "repos", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" }, { "name": "hook_id", "in": "path", "required": true, "schema": { "type": "integer" }, "descriptionHTML": "" } ], "bodyParameters": [], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { "owner": "OWNER", "repo": "REPO", "hook_id": "HOOK_ID" } }, "response": { "statusCode": "204", "description": "Response
" } } ], "previews": [], "descriptionHTML": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.
Note: Previously /repos/:owner/:repo/hooks/:hook_id/test
No Content
" }, { "httpStatusCode": "404", "description": "Resource not found
" } ] } ] } }