Mutations

Clear all of a customer's queued migrations.

Input fields for abortQueuedMigrations

• input (AbortQueuedMigrationsInput!)

Return fields for abortQueuedMigrations

Adds assignees to an assignable object.

Input fields for addAssigneesToAssignable

• input (AddAssigneesToAssignableInput!)

Return fields for addAssigneesToAssignable

Adds a comment to an Issue or Pull Request.

Input fields for addComment

• input (AddCommentInput!)

Return fields for addComment

Adds a comment to a Discussion, possibly as a reply to another comment.

Input fields for addDiscussionComment

• input (AddDiscussionCommentInput!)

Return fields for addDiscussionComment

Vote for an option in a discussion poll.

Input fields for addDiscussionPollVote

• input (AddDiscussionPollVoteInput!)

Return fields for addDiscussionPollVote

Adds an administrator to the global enterprise account.

Input fields for addEnterpriseAdmin

• input (AddEnterpriseAdminInput!)

Return fields for addEnterpriseAdmin

Adds labels to a labelable object.

Input fields for addLabelsToLabelable

• input (AddLabelsToLabelableInput!)

Return fields for addLabelsToLabelable

Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.

Input fields for addProjectCard

• input (AddProjectCardInput!)

Return fields for addProjectCard

Adds a column to a Project.

Input fields for addProjectColumn

• input (AddProjectColumnInput!)

Return fields for addProjectColumn

Creates a new draft issue and add it to a Project.

Input fields for addProjectV2DraftIssue

• input (AddProjectV2DraftIssueInput!)

Return fields for addProjectV2DraftIssue

Links an existing content instance to a Project.

Input fields for addProjectV2ItemById

• input (AddProjectV2ItemByIdInput!)

Return fields for addProjectV2ItemById

Adds a review to a Pull Request.

Input fields for addPullRequestReview

• input (AddPullRequestReviewInput!)

Return fields for addPullRequestReview

Adds a comment to a review.

Input fields for addPullRequestReviewComment

• input (AddPullRequestReviewCommentInput!)

Return fields for addPullRequestReviewComment

Adds a new thread to a pending Pull Request Review.

Input fields for addPullRequestReviewThread

• input (AddPullRequestReviewThreadInput!)

Return fields for addPullRequestReviewThread

Adds a reaction to a subject.

Input fields for addReaction

• input (AddReactionInput!)

Return fields for addReaction

Adds a star to a Starrable.

Input fields for addStar

• input (AddStarInput!)

Return fields for addStar

Add an upvote to a discussion or discussion comment.

Input fields for addUpvote

• input (AddUpvoteInput!)

Return fields for addUpvote

Adds a verifiable domain to an owning account.

Input fields for addVerifiableDomain

• input (AddVerifiableDomainInput!)

Return fields for addVerifiableDomain

Approve all pending deployments under one or more environments.

Input fields for approveDeployments

• input (ApproveDeploymentsInput!)

Return fields for approveDeployments

Approve a verifiable domain for notification delivery.

Input fields for approveVerifiableDomain

• input (ApproveVerifiableDomainInput!)

Return fields for approveVerifiableDomain

Marks a repository as archived.

Input fields for archiveRepository

• input (ArchiveRepositoryInput!)

Return fields for archiveRepository

Update your status on GitHub.

Input fields for changeUserStatus

• input (ChangeUserStatusInput!)

Return fields for changeUserStatus

Clears all labels from a labelable object.

Input fields for clearLabelsFromLabelable

• input (ClearLabelsFromLabelableInput!)

Return fields for clearLabelsFromLabelable

Creates a new project by cloning configuration from an existing project.

Input fields for cloneProject

• input (CloneProjectInput!)

Return fields for cloneProject

Create a new repository with the same files and directory structure as a template repository.

Input fields for cloneTemplateRepository

• input (CloneTemplateRepositoryInput!)

Return fields for cloneTemplateRepository

Close an issue.

Input fields for closeIssue

• input (CloseIssueInput!)

Return fields for closeIssue

Close a pull request.

Input fields for closePullRequest

• input (ClosePullRequestInput!)

Return fields for closePullRequest

Convert a project note card to one associated with a newly created issue.

Input fields for convertProjectCardNoteToIssue

• input (ConvertProjectCardNoteToIssueInput!)

Return fields for convertProjectCardNoteToIssue

Converts a pull request to draft.

Input fields for convertPullRequestToDraft

• input (ConvertPullRequestToDraftInput!)

Return fields for convertPullRequestToDraft

Create a new branch protection rule.

Input fields for createBranchProtectionRule

• input (CreateBranchProtectionRuleInput!)

Return fields for createBranchProtectionRule

Create a check run.

Input fields for createCheckRun

• input (CreateCheckRunInput!)

Return fields for createCheckRun

Create a check suite.

Input fields for createCheckSuite

• input (CreateCheckSuiteInput!)

Return fields for createCheckSuite

Appends a commit to the given branch as the authenticated user.

This mutation creates a commit whose parent is the HEAD of the provided branch and also updates that branch to point to the new commit. It can be thought of as similar to git commit.

Locating a Branch

Commits are appended to a branch of type Ref. This must refer to a git branch (i.e. the fully qualified path must begin with refs/heads/, although including this prefix is optional.

Callers may specify the branch to commit to either by its global node ID or by passing both of repositoryNameWithOwner and refName. For more details see the documentation for CommittableBranch.

Describing Changes

fileChanges are specified as a FilesChanges object describing FileAdditions and FileDeletions.

Please see the documentation for FileChanges for more information on how to use this argument to describe any set of file changes.

Authorship

Similar to the web commit interface, this mutation does not support specifying the author or committer of the commit and will not add support for this in the future.

A commit created by a successful execution of this mutation will be authored by the owner of the credential which authenticates the API request. The committer will be identical to that of commits authored using the web interface.

If you need full control over author and committer information, please use the Git Database REST API instead.

Commit Signing

Commits made using this mutation are automatically signed by GitHub if supported and will be marked as verified in the user interface.

Input fields for createCommitOnBranch

• input (CreateCommitOnBranchInput!)

Return fields for createCommitOnBranch

Creates a new deployment event.

Input fields for createDeployment

• input (CreateDeploymentInput!)

Return fields for createDeployment

Create a deployment status.

Input fields for createDeploymentStatus

• input (CreateDeploymentStatusInput!)

Return fields for createDeploymentStatus

Create a discussion.

Input fields for createDiscussion

• input (CreateDiscussionInput!)

Return fields for createDiscussion

Creates an organization as part of an enterprise account.

Input fields for createEnterpriseOrganization

• input (CreateEnterpriseOrganizationInput!)

Return fields for createEnterpriseOrganization

Creates an environment or simply returns it if already exists.

Input fields for createEnvironment

• input (CreateEnvironmentInput!)

Return fields for createEnvironment

Creates a new IP allow list entry.

Input fields for createIpAllowListEntry

• input (CreateIpAllowListEntryInput!)

Return fields for createIpAllowListEntry

Creates a new issue.

Input fields for createIssue

• input (CreateIssueInput!)

Return fields for createIssue

Creates a new label.

Input fields for createLabel

• input (CreateLabelInput!)

Return fields for createLabel

Creates an Octoshift migration source.

Input fields for createMigrationSource

• input (CreateMigrationSourceInput!)

Return fields for createMigrationSource

Creates a new project.

Input fields for createProject

• input (CreateProjectInput!)

Return fields for createProject

Creates a new project.

Input fields for createProjectV2

• input (CreateProjectV2Input!)

Return fields for createProjectV2

Create a new pull request.

Input fields for createPullRequest

• input (CreatePullRequestInput!)

Return fields for createPullRequest

Create a new Git Ref.

Input fields for createRef

• input (CreateRefInput!)

Return fields for createRef

Create a new repository.

Input fields for createRepository

• input (CreateRepositoryInput!)

Return fields for createRepository

Creates a new team discussion.

Input fields for createTeamDiscussion

• input (CreateTeamDiscussionInput!)

Return fields for createTeamDiscussion

Creates a new team discussion comment.

Input fields for createTeamDiscussionComment

• input (CreateTeamDiscussionCommentInput!)

Return fields for createTeamDiscussionComment

Delete a branch protection rule.

Input fields for deleteBranchProtectionRule

• input (DeleteBranchProtectionRuleInput!)

Return fields for deleteBranchProtectionRule

Deletes a deployment.

Input fields for deleteDeployment

• input (DeleteDeploymentInput!)

Return fields for deleteDeployment

Delete a discussion and all of its replies.

Input fields for deleteDiscussion

• input (DeleteDiscussionInput!)

Return fields for deleteDiscussion

Delete a discussion comment. If it has replies, wipe it instead.

Input fields for deleteDiscussionComment

• input (DeleteDiscussionCommentInput!)

Return fields for deleteDiscussionComment

Deletes an environment.

Input fields for deleteEnvironment

• input (DeleteEnvironmentInput!)

Return fields for deleteEnvironment

Deletes an IP allow list entry.

Input fields for deleteIpAllowListEntry

• input (DeleteIpAllowListEntryInput!)

Return fields for deleteIpAllowListEntry