Expand description
The data types sent to and returned from the API client.
Structs
- All of the following types are flattened into one object:
- The public key used for setting Actions Secrets.
- Set secrets for GitHub Actions.
- All of the following types are flattened into one object:
- All of the following types are flattened into one object:
- Actor
- Added to Project Issue Event
- Successful deletion of a code scanning analysis
- Api Overview
- The permissions granted to the user-to-server access token.
- The authorization associated with an OAuth Access.
- All of the following types are flattened into one object:
- An artifact
- Assigned Issue Event
- Authentication Token
- The authorization for an OAuth app, GitHub App, or a Personal Access Token.
- The status of auto merging a pull request.
- An autolink reference.
- Base Gist
- Basic Error
- Blob
- Branch Protection
- Branch Restriction Policy
- Branch Short
- Branch With Protection
- Check Annotation
- A check performed on the code of a given code change
- A suite of checks performed on the code of a given code change
- Check suite configuration preferences for a repository.
- Check runs can accept a variety of data in the
output
object, including atitle
andsummary
and can optionally provide descriptive details about the run. See theoutput
object description. - Check runs can accept a variety of data in the
output
object, including atitle
andsummary
and can optionally provide descriptive details about the run. See theoutput
object description. - Clone Traffic
- Code Of Conduct
- Code of Conduct Simple
- Describe a region within a file for the alert.
- Code Search Result Item
- Collaborator
- Combined Commit Status
- Commit Activity
- Commit Comment
- Commit Comparison
- Commit
- Commit Search Result Item
- Identifying information for the git-user
- Community Profile
- Content File
- Content Reference attachments allow you to provide context around URLs posted in comments
- An object describing a symlink
- Content Traffic
- Content Tree
- Contributor
- Contributor Activity
- Converted Note to Issue Issue Event
- Credential Authorization
- An SSH key granting access to a single repository.
- A request for a specific ref(branch,sha,tag) to be deployed
- The type of deployment branch policy for this environment. To allow all branches to deploy, set to
null
. - A deployment created as the result of an Actions check run from a workflow that references an environment
- The status of a deployment.
- Diff Entry
- Email
- An enterprise account
- An entry in the reviews log for environment deployments
- Details of a deployment environment
- Event
- Feed
- File Commit
- Names and content for the files that make up the gist
- Names of files to be updated
- Full Repository
- Groups of organization members that gives permissions on specified repositories.
- Gist
- A comment made to a gist.
- Gist Commit
- Gist History
- Gist Simple
- Low-level Git commit operations within a repository
- Information about the author of the commit. By default, the
author
will be the authenticated user and the current date. See theauthor
andcommitter
object below for details. - Information about the person who is making the commit. By default,
committer
will use the information set inauthor
. See theauthor
andcommitter
object below for details. - An object with information about the individual creating the tag.
- GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- Git references within a repository
- Metadata for a Git tag
- The hierarchy between files in a Git repository.
- Gitignore Template
- A unique encryption key
- External Groups to be mapped to a team for membership
- Webhooks for repositories.
- Delivery made by a webhook.
- Delivery made by a webhook, without request and response information.
- Hovercard
- A repository import from an external source.
- Installation
- Authentication token for a GitHub App installed on a user or org.
- Limit interactions to a specific type of user for a specified duration
- Interaction limit settings.
- All of the following types are flattened into one object:
- Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
- Comments provide a way for people to collaborate on an issue.
- Issue Event
- All of the following types are flattened into one object:
- Issue Event Label
- Issue Event Milestone
- Issue Event Project Card
- Issue Search Result Item
- Issue Simple
- All of the following types are flattened into one object:
- Information of a job execution in a workflow run
- Key
- Key Simple
- Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
- Label Search Result Item
- Labeled Issue Event
- License Content
- License
- License Simple
- Hypermedia Link
- Hypermedia Link with Type
- Locked Issue Event
- Marketplace Listing Plan
- Marketplace Purchase
- A migration.
- A collection of related issues and pull requests.
- Milestoned Issue Event
- Minimal Repository
- Moved Column in Project Issue Event
- Org Hook
- Org Membership
- Secrets for GitHub Actions for an organization.
- Organization Full
- Organization Invitation
- Organization Simple
- Key/value pairs to provide settings for this webhook. These are defined below.
- Key/value pairs to provide settings for this webhook. These are defined below.
- A software package
- A version of a software package
- The configuration for GitHub Pages for a repository.
- Page Build
- Page Build Status
- Pages Health Check Status
- Details of a deployment that is waiting for protection rules to pass
- The set of permissions for the GitHub app
- Porter Author
- Porter Large File
- Private User
- Projects are a way to organize columns and cards of work.
- Project cards represent a scope of work.
- Project columns contain cards of work.
- Branch protections protect branches
- Protected Branch Pull Request Review
- All of the following types are flattened into one object:
- Public User
- Pull requests let you tell others about changes you’ve pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
- Pull Request Merge Result
- Pull Request Review Request
- Pull Request Review Comments are comments on a portion of the Pull Request’s diff.
- Pull Request Reviews are reviews on pull requests.
- Pull Request Simple
- Rate Limit Overview
- Reactions to conversations provide a way to help people express their feelings more simply and effectively.
- Referrer Traffic
- A release.
- Data related to a release.
- Removed from Project Issue Event
- Renamed Issue Event
- Repo Search Result Item
- The source branch and directory used to publish your Pages site.
- The source branch and directory used to publish your Pages site.
- Key/value pairs to provide settings for this webhook. These are defined below.
- Require at least one approving review on a pull request, before merging. Set to
null
to disable. - Specify which users and teams can dismiss pull request reviews. Pass an empty
dismissal_restrictions
object to disable. User and teamdismissal_restrictions
are only available for organization-owned repositories. Omit this parameter for personal repositories. - Require status checks to pass before merging. Set to
null
to disable. - 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 aGET /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.” - Key/value pairs to provide settings for this webhook. These are defined below.
- A git repository
- Repository Collaborator Permission
- Repository invitations let you manage who you collaborate with.
- Repository invitations let you manage who you collaborate with.
- Restrict who can push to the protected branch. User, app, and team
restrictions
are only available for organization-owned repositories. Set tonull
to disable. - Legacy Review Comment
- Review Dismissed Issue Event
- Review Request Removed Issue Event
- Review Requested Issue Event
- All of the following types are flattened into one object:
- A self hosted runner
- Runner Application
- Scim Error
- SCIM /Users provisioning endpoints
- SCIM User List
- Short Branch
- Simple Commit
- Simple User
- All of the following types are flattened into one object:
- Update the source for the repository. Must include the branch name and path.
- Stargazer
- Starred Repository
- Status Check Policy
- The status of a commit.
- An object describing a symlink
- Tag
- Groups of organization members that gives permissions on specified repositories.
- A team discussion is a persistent record of a free-form conversation within a team.
- A reply to a discussion within a team.
- Team Membership
- A team’s access to a project.
- A team’s access to a repository.
- Groups of organization members that gives permissions on specified repositories.
- Thread
- Thread Subscription
- Timeline Assigned Issue Event
- Timeline Comment Event
- Timeline Commit Commented Event
- Timeline Committed Event
- Timeline Cross Referenced Event
- Timeline Line Commented Event
- Timeline Reviewed Event
- A topic aggregates entities that are related to a subject.
- Topic Search Result Item
- User Marketplace Purchase
- User Search Result Item
- Validation Error
- Validation Error Simple
- View Traffic
- Configuration object of the webhook
- A GitHub Actions workflow
- An invocation of a workflow
- Workflow Run Usage
- Workflow Usage
Enums
- Filters jobs by their
completed_at
timestamp. Can be one of:
*latest
: Returns jobs from the most recent execution of the workflow run.
*all
: Returns all jobs for a workflow run, including from old executions of the workflow run. - Filters the collaborators by their affiliation. Can be one of:
*outside
: Outside collaborators of a project that are not a member of the project’s organization.
*direct
: Collaborators with permissions to a project, regardless of organization membership status.
*all
: All collaborators the authenticated user can see. - The permissions policy that controls the actions that are allowed to run. Can be one of:
all
,local_only
, orselected
. - The level of the annotation. Can be one of
notice
,warning
, orfailure
. - Filters the project cards that are returned by the card’s state. Can be one of
all
,archived
, ornot_archived
. - How the author is associated with the repository.
- Required if you provide
completed_at
or astatus
ofcompleted
. The final conclusion of the check. Can be one ofaction_required
,cancelled
,failure
,neutral
,success
,skipped
,stale
, ortimed_out
. When the conclusion isaction_required
, additional details should be provided on the site specified bydetails_url
.
Note: Providingconclusion
will automatically set thestatus
parameter tocompleted
. You cannot change a check run conclusion tostale
, only GitHub can set this. - A classification of the file. For example to identify it as generated.
- Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of:
false positive
,won't fix
, andused in tests
. - Sets the state of the code scanning alert. Can be one of
open
ordismissed
. You must providedismissed_reason
when you set the state todismissed
. - State of a code scanning alert.
- The reaction to use
- The type of reviewer. Must be one of:
User
orTeam
- The state of the status.
- The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of:
all
,none
, orselected
. - Whether deployment to the environment(s) was approved or rejected
- Allowed values that can be passed to the exclude param.
- Indicates which sorts of issues to return. Can be one of:
*assigned
: Issues assigned to you
*created
: Issues created by you
*mentioned
: Issues mentioning you
*subscribed
: Issues you’re subscribed to updates for
*all
orrepos
: All issues the authenticated user can see, regardless of participation or creation - The type of the object we’re tagging. Normally this is a
commit
but it can also be atree
or ablob
. - The file mode; one of
100644
for file (blob),100755
for executable (blob),040000
for subdirectory (tree),160000
for submodule (commit), or120000
for a blob that specifies the path of a symlink. - The event types to include:
- The duration of the interaction restriction. Can be one of:
one_day
,three_days
,one_week
,one_month
,six_months
. Default:one_day
. - 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
. - All of the following types:
- All of the following types:
- What to sort results by. Either
due_on
orcompleteness
. - What to sort results by. Can be either
created
,updated
,comments
. - Indicates the state of the issues to return. Can be either
open
,closed
, orall
. - The phase of the lifecycle that the job is currently in.
- All of the following types:
- The reason for locking the issue or pull request conversation. Lock will fail if you don’t use one of these reasons:
*off-topic
*too heated
*resolved
*spam
- Specifies which types of repositories non-admin organization members can create. Can be one of:
*all
- all organization members can create public and private repositories.
*private
- members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
*none
- only admin members can create repositories.
Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set inmembers_can_create_repositories
. See the parameter deprecation notice in the operation description for details. - The merge method to use.
- The rendering mode.
- The order of audit log events. To list newest events first, specify
desc
. To list oldest events first, specifyasc
. - The state of the member in the organization. The
pending
state indicates the user has not yet accepted an invitation. - The baseline permission that all organization members have on this project. Only present if owner is an organization.
- The level of permission to grant the access token for viewing an organization’s plan. Can be one of:
read
. - Specify role for new member. Can be one of:
*admin
- Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
*direct_member
- Non-owner organization members with ability to see other members and join teams by invitation.
*billing_manager
- Non-owner organization members with ability to manage the billing settings of your organization. - Filter members returned in the list. Can be one of:
*2fa_disabled
- Members without two-factor authentication enabled. Available for organization owners.
*all
- All members the authenticated user can see. - Filter members returned by their role. Can be one of:
*all
- All members of the organization, regardless of role.
*admin
- Organization owners.
*member
- Non-owner organization members. - The role to give the user in the organization. Can be one of:
*admin
- The user will become an owner of the organization.
*member
- The user will become a non-owner member of the organization. - The state that the membership should be in. Only
"active"
will be accepted. - All of the following types:
- The state of the package, either active or deleted.
- The status of the most recent build of the Page.
- The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of:
read
orwrite
. - The repository directory that includes the source files for the Pages site. Allowed paths are
/
or/docs
. Default:/
- All of the following types:
- Must be one of:
day
,week
. - Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
*pull
- team members can pull, but not push to or administer newly-added repositories.
*push
- team members can pull and push, but not administer newly-added repositories.
*admin
- team members can pull, push and administer newly-added repositories. - The level of privacy this team should have
pending
files have not yet been processed, whilecomplete
means all results in the SARIF have been stored.- All of the following types:
- All of the following types:
- Required when using multi-line comments. To create multi-line comments, you must use the
comfort-fade
preview header. Thestart_side
is the starting side of the diff that the comment applies to. Can beLEFT
orRIGHT
. To learn more about multi-line comments, see “Commenting on a pull request” in the GitHub Help documentation. Seeside
in this table for additional context. - The review action you want to perform. The review actions include:
APPROVE
,REQUEST_CHANGES
, orCOMMENT
. By leaving this blank, you set the review action state toPENDING
, which means you will need to submit the pull request review when you are ready. - What to sort results by. Can be either
created
,updated
,popularity
(comment count) orlong-running
(age, filtering by pulls updated in the last month). - The reaction type to add to the release.
- State of the release asset.
- All of the following types:
- All of the following types:
- All of the following types:
- All of the following types:
- The state of the status. Can be one of
error
,failure
,pending
, orsuccess
. - Name for the target deployment environment, which can be changed when setting a deploy status. For example,
production
,staging
, orqa
. Note: This parameter requires you to use theapplication/vnd.github.flash-preview+json
custom media type. - Can be
public
orprivate
. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+,visibility
can also beinternal
. 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.
Thevisibility
parameter overrides theprivate
parameter when you use both parameters with thenebula-preview
preview header. - All of the following types:
- The sort order. Can be either
newest
,oldest
, orstargazers
. - Can be one of
created
,updated
,pushed
,full_name
. - 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 ofall
,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 beinternal
. However, theinternal
value is not yet supported when a GitHub App calls this API with an installation access token. - Can be one of
all
,owner
,public
,private
,member
. Note: For GitHub AE, can be one ofall
,owner
,internal
,private
,member
. Default:all
- Can be one of
all
,owner
,member
. - Can be one of
all
,public
, orprivate
. Note: For GitHub AE, can be one ofall
,internal
, orprivate
. - The permission associated with the invitation.
- The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of:
read
,write
, oradmin
. - Describe whether all repositories have been selected or there’s a selection involved
- The user’s membership type in the organization.
- All of the following types:
- All of the following types:
- 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 - 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
, orinteractions
. You can also sort results by how recently the items werecreated
orupdated
, Default: best match - Sorts the results of your query by number of
stars
,forks
, orhelp-wanted-issues
or how recently the items wereupdated
. Default: best match - Sorts the results of your query by number of
followers
orrepositories
, or when the personjoined
GitHub. Default: best match - Required when the
state
isresolved
. The reason for resolving the alert. Can be one offalse_positive
,wont_fix
,revoked
, orused_in_tests
. - Sets the state of the secret scanning alert. Can be either
open
orresolved
. You must provideresolution
when you set the state toresolved
. - The security severity of the alert.
- The severity of the alert.
- The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
- One of
created
(when the repository was starred) orupdated
(when it was last pushed to). - Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory
/docs
. Possible values are"gh-pages"
,"master"
, and"master /docs"
. - The state of the milestone.
- Identifies which additional information you’d like to receive about the person’s hovercard. Can be
organization
,repository
,issue
,pull_request
. Required when usingsubject_id
. - The role of the user in the team.
- The permission to grant the team on this repository. Can be one of:
*pull
- team members can pull, but not push to or administer this repository.
*push
- team members can pull and push, but not administer this repository.
*admin
- team members can pull, push and administer this repository.
*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.
*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. - Filters members returned by their role in the team. Can be one of:
*member
- normal members of the team.
*maintainer
- team maintainers.
*all
- all members of the team. - All of the following types:
- The type of label. Read-only labels are applied automatically when the runner is configured.
- Can be one of
opt_in
(large files will be stored using Git LFS) oropt_out
(large files will be removed during the import). - All of the following types:
- All of the following types:
- All of the following types:
- The originating VCS type. Can be one of
subversion
,git
,mercurial
, ortfvc
. 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. - Visibility of a secret
- All of the following types:
- Returns workflow runs with the check run
status
orconclusion
that you specify. For example, a conclusion can besuccess
or a status can bein_progress
. Only GitHub can set a status ofwaiting
orrequested
. For a list of the possiblestatus
andconclusion
options, see “Create a check run.” - The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of:
write
.