repos

Overview

Name	repos
Type	Resource
Id	github.repos.repos

Fields

Name	Datatype	Description
id	integer
name	string
description	string
default_branch	string
git_refs_url	string
delete_branch_on_merge	boolean
languages_url	string
created_at	string
commits_url	string
tags_url	string
subscribers_url	string
comments_url	string
stargazers_count	integer
svn_url	string
assignees_url	string
watchers_count	integer
statuses_url	string
contributors_url	string
role_name	string
subscription_url	string
open_issues_count	integer
ssh_url	string
allow_forking	boolean
pushed_at	string
homepage	string
updated_at	string
releases_url	string
has_issues	boolean
archive_url	string
has_pages	boolean
template_repository	object	A git repository
topics	array
size	integer
stargazers_url	string
compare_url	string
disabled	boolean
is_template	boolean
trees_url	string
fork	boolean
full_name	string
temp_clone_token	string
deployments_url	string
subscribers_count	integer
downloads_url	string
branches_url	string
mirror_url	string
collaborators_url	string
has_projects	boolean
labels_url	string
has_wiki	boolean
events_url	string
keys_url	string
teams_url	string
issue_events_url	string
watchers	integer
hooks_url	string
network_count	integer
issues_url	string
blobs_url	string
milestones_url	string
private	boolean
issue_comment_url	string
forks	integer
forks_count	integer
html_url	string
permissions	object
url	string
node_id	string
language	string
open_issues	integer
git_url	string
merges_url	string
visibility	string
pulls_url	string
forks_url	string
archived	boolean
code_of_conduct	object	Code Of Conduct
notifications_url	string
has_downloads	boolean
git_commits_url	string
clone_url	string
owner	object	Simple User
license	object
git_tags_url	string
contents_url	string

Methods

Name	Accessible by	Required Params	Description
get	SELECT	owner, repo	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.
list_for_authenticated_user	SELECT		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.
list_for_org	SELECT	org	Lists repositories for the specified organization.
list_for_user	SELECT	username	Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.
create_for_authenticated_user	INSERT	data__name	Creates a new repository for the authenticated user. OAuth scope requirements When using OAuth, authorizations must include: public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository. repo scope to create a private repository.
create_in_org	INSERT	org, data__name	Creates a new repository in the specified organization. The authenticated user must be a member of the organization. OAuth scope requirements When using OAuth, authorizations must include: public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository. repo scope to create a private repository
create_using_template	INSERT	template_owner, template_repo, data__name	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 When using OAuth, authorizations must include: public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository. repo scope to create a private repository
delete	DELETE	owner, repo	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 repositories, you will get a 403 Forbidden response.
check_vulnerability_alerts	EXEC	owner, repo	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".
codeowners_errors	EXEC	owner, repo	List any syntax errors that are detected in the CODEOWNERS file. For more information about the correct CODEOWNERS syntax, see "About code owners."
create_dispatch_event	EXEC	owner, repo, data__event_type	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: - Personal access tokens with repo scope. For more information, see "Creating a personal access token for the command line" in the GitHub Help documentation. - GitHub Apps with both metadata:read and contents:read&write permissions. This input example shows how you can use the client_payload as a test to debug your workflow.
disable_automated_security_fixes	EXEC	owner, repo	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".
disable_vulnerability_alerts	EXEC	owner, repo	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".
enable_automated_security_fixes	EXEC	owner, repo	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".
enable_vulnerability_alerts	EXEC	owner, repo	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".
transfer	EXEC	owner, repo, data__new_owner	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.
update	EXEC	owner, repo	Note: To edit a repository's topics, use the Replace all repository topics endpoint.