PATCH /repos/{owner}/{repo}
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
Servers
- https://api.github.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
owner |
String | Yes |
The account owner of the repository. The name is not case sensitive. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
description |
String | No |
A short description of the repository. |
merge_commit_message |
String | No |
The default value for a merge commit message.
Possible values:
|
security_and_analysis |
Object | No |
Specify which security and analysis features to enable or disable for the repository. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." For example, to enable GitHub Advanced Security, use this data in the body of the You can check which security and analysis features are currently enabled by using a |
security_and_analysis.secret_scanning |
Object | No |
Use the |
security_and_analysis.secret_scanning.status |
String | No |
Can be |
security_and_analysis.secret_scanning_non_provider_patterns |
Object | No |
Use the |
security_and_analysis.secret_scanning_non_provider_patterns.status |
String | No |
Can be |
security_and_analysis.advanced_security |
Object | No |
Use the |
security_and_analysis.advanced_security.status |
String | No |
Can be |
security_and_analysis.secret_scanning_ai_detection |
Object | No |
Use the |
security_and_analysis.secret_scanning_ai_detection.status |
String | No |
Can be |
security_and_analysis.secret_scanning_push_protection |
Object | No |
Use the |
security_and_analysis.secret_scanning_push_protection.status |
String | No |
Can be |
security_and_analysis.code_security |
Object | No |
Use the |
security_and_analysis.code_security.status |
String | No |
Can be |
has_wiki |
Boolean | No |
Either Default value: true |
merge_commit_title |
String | No |
Required when using The default value for a merge commit title.
Possible values:
|
is_template |
Boolean | No |
Either Default value: false |
default_branch |
String | No |
Updates the default branch for this repository. |
allow_rebase_merge |
Boolean | No |
Either Default value: true |
web_commit_signoff_required |
Boolean | No |
Either Default value: false |
has_projects |
Boolean | No |
Either Default value: true |
allow_update_branch |
Boolean | No |
Either Default value: false |
use_squash_pr_title_as_default |
Boolean | No |
Either Default value: false |
archived |
Boolean | No |
Whether to archive this repository. Default value: false |
squash_merge_commit_message |
String | No |
The default value for a squash merge commit message:
Possible values:
|
has_issues |
Boolean | No |
Either Default value: true |
squash_merge_commit_title |
String | No |
Required when using The default value for a squash merge commit title:
Possible values:
|
allow_squash_merge |
Boolean | No |
Either Default value: true |
delete_branch_on_merge |
Boolean | No |
Either Default value: false |
visibility |
String | No |
The visibility of the repository. Possible values:
|
homepage |
String | No |
A URL with more information about the repository. |
name |
String | No |
The name of the repository. |
allow_forking |
Boolean | No |
Either Default value: false |
allow_auto_merge |
Boolean | No |
Either Default value: false |
private |
Boolean | No |
Either Default value: false |
allow_merge_commit |
Boolean | No |
Either Default value: true |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.