Mutations

Clear all of a customer's queued migrations.

Input fields for abortQueuedMigrations

• input (AbortQueuedMigrationsInput!)

Return fields for abortQueuedMigrations

Abort a repository migration queued or in progress.

Input fields for abortRepositoryMigration

• input (AbortRepositoryMigrationInput!)

Return fields for abortRepositoryMigration

Accepts a pending invitation for a user to become an administrator of an enterprise.

Input fields for acceptEnterpriseAdministratorInvitation

• input (AcceptEnterpriseAdministratorInvitationInput!)

Return fields for acceptEnterpriseAdministratorInvitation

Accepts a pending invitation for a user to become an unaffiliated member of an enterprise.

Input fields for acceptEnterpriseMemberInvitation

• input (AcceptEnterpriseMemberInvitationInput!)

Return fields for acceptEnterpriseMemberInvitation

Applies a suggested topic to the repository.

Input fields for acceptTopicSuggestion

• input (AcceptTopicSuggestionInput!)

Return fields for acceptTopicSuggestion

Access user namespace repository for a temporary duration.

Input fields for accessUserNamespaceRepository

• input (AccessUserNamespaceRepositoryInput!)

Return fields for accessUserNamespaceRepository

Adds assignees to an assignable object.

Input fields for addAssigneesToAssignable

• input (AddAssigneesToAssignableInput!)

Return fields for addAssigneesToAssignable

Adds a 'blocked by' relationship to an issue.

Input fields for addBlockedBy

• input (AddBlockedByInput!)

Return fields for addBlockedBy

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 enterprise members to an organization within the enterprise.

Input fields for addEnterpriseOrganizationMember

• input (AddEnterpriseOrganizationMemberInput!)

Return fields for addEnterpriseOrganizationMember

Adds a support entitlement to an enterprise member.

Input fields for addEnterpriseSupportEntitlement

• input (AddEnterpriseSupportEntitlementInput!)

Return fields for addEnterpriseSupportEntitlement

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 reply to an existing Pull Request Review Thread.

Input fields for addPullRequestReviewThreadReply

• input (AddPullRequestReviewThreadReplyInput!)

Return fields for addPullRequestReviewThreadReply

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

Adds a sub-issue to a given issue.

Input fields for addSubIssue

• input (AddSubIssueInput!)

Return fields for addSubIssue

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

Archives a ProjectV2Item.

Input fields for archiveProjectV2Item

• input (ArchiveProjectV2ItemInput!)

Return fields for archiveProjectV2Item

Marks a repository as archived.

Input fields for archiveRepository

• input (ArchiveRepositoryInput!)

Return fields for archiveRepository

Cancels a pending invitation for an administrator to join an enterprise.

Input fields for cancelEnterpriseAdminInvitation

• input (CancelEnterpriseAdminInvitationInput!)

Return fields for cancelEnterpriseAdminInvitation

Cancels a pending invitation for an unaffiliated member to join an enterprise.

Input fields for cancelEnterpriseMemberInvitation

• input (CancelEnterpriseMemberInvitationInput!)

Return fields for cancelEnterpriseMemberInvitation

Cancel an active sponsorship.

Input fields for cancelSponsorship

• input (CancelSponsorshipInput!)

Return fields for cancelSponsorship

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

This mutation clears the value of a field for an item in a Project. Currently only text, number, date, assignees, labels, single-select, iteration and milestone fields are supported.

Input fields for clearProjectV2ItemFieldValue

• input (ClearProjectV2ItemFieldValueInput!)

Return fields for clearProjectV2ItemFieldValue

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 a discussion.

Input fields for closeDiscussion

• input (CloseDiscussionInput!)

Return fields for closeDiscussion

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 projectV2 draft issue item to an issue.

Input fields for convertProjectV2DraftIssueItemToIssue

• input (ConvertProjectV2DraftIssueItemToIssueInput!)

Return fields for convertProjectV2DraftIssueItemToIssue

Converts a pull request to draft.

Input fields for convertPullRequestToDraft

• input (ConvertPullRequestToDraftInput!)

Return fields for convertPullRequestToDraft

Copy a project.

Input fields for copyProjectV2

• input (CopyProjectV2Input!)

Return fields for copyProjectV2

Invites a user to claim reattributable data.

Input fields for createAttributionInvitation

• input (CreateAttributionInvitationInput!)

Return fields for createAttributionInvitation

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. A personal access token used to create an organization is implicitly permitted to update the organization it created, if the organization is part of an enterprise that has SAML enabled or uses Enterprise Managed Users. If the organization is not part of such an enterprise, and instead has SAML enabled for it individually, the token will then require SAML authorization to continue working against that organization.

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 issue type.

Input fields for createIssueType

• input (CreateIssueTypeInput!)

Return fields for createIssueType

Creates a new label.

Input fields for createLabel

• input (CreateLabelInput!)

Return fields for createLabel

Create a branch linked to an issue.

Input fields for createLinkedBranch

• input (CreateLinkedBranchInput!)

Return fields for createLinkedBranch

Creates a GitHub Enterprise Importer (GEI) 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 project field.

Input fields for createProjectV2Field

• input (CreateProjectV2FieldInput!)

Return fields for createProjectV2Field

Creates a status update within a Project.

Input fields for createProjectV2StatusUpdate

• input (CreateProjectV2StatusUpdateInput!)

Return fields for createProjectV2StatusUpdate

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

Create a repository ruleset.

Input fields for createRepositoryRuleset

• input (CreateRepositoryRulesetInput!)

Return fields for createRepositoryRuleset

Create a GitHub Sponsors profile to allow others to sponsor you or your organization.

Input fields for createSponsorsListing

• input (CreateSponsorsListingInput!)

Return fields for createSponsorsListing

Create a new payment tier for your GitHub Sponsors profile.

Input fields for createSponsorsTier

• input (CreateSponsorsTierInput!)

Return fields for createSponsorsTier

Start a new sponsorship of a maintainer in GitHub Sponsors, or reactivate a past sponsorship.

Input fields for createSponsorship

• input (CreateSponsorshipInput!)

Return fields for createSponsorship

Make many sponsorships for different sponsorable users or organizations at once. Can only sponsor those who have a public GitHub Sponsors profile.

Input fields for createSponsorships

• input (CreateSponsorshipsInput!)

Return fields for createSponsorships

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

Creates a new user list.

Input fields for createUserList

• input (CreateUserListInput!)

Return fields for createUserList

Rejects a suggested topic for the repository.

Input fields for declineTopicSuggestion

• input (DeclineTopicSuggestionInput!)

Return fields for declineTopicSuggestion

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

Deletes an Issue object.

Input fields for deleteIssue

• input (DeleteIssueInput!)

Return fields for deleteIssue

Deletes an IssueComment object.

Input fields for deleteIssueComment

• input (DeleteIssueCommentInput!)

Return fields for deleteIssueComment

Delete an issue type.

Input fields for deleteIssueType

• input (DeleteIssueTypeInput!)

Return fields for deleteIssueType

Deletes a label.

Input fields for deleteLabel

• input (DeleteLabelInput!)

Return fields for deleteLabel

Unlink a branch from an issue.

Input fields for deleteLinkedBranch

• input (DeleteLinkedBranchInput!)

Return fields for deleteLinkedBranch

Delete a package version.

Input fields for deletePackageVersion

• input (DeletePackageVersionInput!)

Return fields for deletePackageVersion

Deletes a project.

Input fields for deleteProject

• input (DeleteProjectInput!)

Return fields for deleteProject

Deletes a project card.

Input fields for deleteProjectCard

• input (DeleteProjectCardInput!)

Return fields for deleteProjectCard

Deletes a project column.

Input fields for deleteProjectColumn

• input (DeleteProjectColumnInput!)

Return fields for deleteProjectColumn

Delete a project.

Input fields for deleteProjectV2

• input (DeleteProjectV2Input!)

Return fields for deleteProjectV2

Delete a project field.

Input fields for deleteProjectV2Field

• input (DeleteProjectV2FieldInput!)

Return fields for deleteProjectV2Field

Deletes an item from a Project.

Input fields for deleteProjectV2Item

• input (DeleteProjectV2ItemInput!)

Return fields for deleteProjectV2Item

Deletes a project status update.

Input fields for deleteProjectV2StatusUpdate

• input (DeleteProjectV2StatusUpdateInput!)

Return fields for deleteProjectV2StatusUpdate

Deletes a project workflow.

Input fields for deleteProjectV2Workflow

• input (DeleteProjectV2WorkflowInput!)

Return fields for deleteProjectV2Workflow

Deletes a pull request review.

Input fields for deletePullRequestReview

• input (DeletePullRequestReviewInput!)

Return fields for deletePullRequestReview

Deletes a pull request review comment.

Input fields for deletePullRequestReviewComment

• input (DeletePullRequestReviewCommentInput!)

Return fields for deletePullRequestReviewComment

Delete a Git Ref.

Input fields for deleteRef

• input (DeleteRefInput!)

Return fields for deleteRef

Delete a repository ruleset.

Input fields for deleteRepositoryRuleset

• input (DeleteRepositoryRulesetInput!)

Return fields for deleteRepositoryRuleset

Deletes a team discussion.

Input fields for deleteTeamDiscussion

• input (DeleteTeamDiscussionInput!)

Return fields for deleteTeamDiscussion

Deletes a team discussion comment.

Input fields for deleteTeamDiscussionComment

• input (DeleteTeamDiscussionCommentInput!)

Return fields for deleteTeamDiscussionComment

Deletes a user list.

Input fields for deleteUserList

• input (DeleteUserListInput!)

Return fields for deleteUserList

Deletes a verifiable domain.

Input fields for deleteVerifiableDomain

• input (DeleteVerifiableDomainInput!)

Return fields for deleteVerifiableDomain

Remove a pull request from the merge queue.

Input fields for dequeuePullRequest

• input (DequeuePullRequestInput!)

Return fields for dequeuePullRequest

Disable auto merge on the given pull request.

Input fields for disablePullRequestAutoMerge

• input (DisablePullRequestAutoMergeInput!)

Return fields for disablePullRequestAutoMerge

Dismisses an approved or rejected pull request review.

Input fields for dismissPullRequestReview

• input (DismissPullRequestReviewInput!)

Return fields for dismissPullRequestReview

Dismisses the Dependabot alert.

Input fields for dismissRepositoryVulnerabilityAlert

• input (DismissRepositoryVulnerabilityAlertInput!)

Return fields for dismissRepositoryVulnerabilityAlert

Enable the default auto-merge on a pull request.

Input fields for enablePullRequestAutoMerge

• input (EnablePullRequestAutoMergeInput!)

Return fields for enablePullRequestAutoMerge

Add a pull request to the merge queue.

Input fields for enqueuePullRequest

• input (EnqueuePullRequestInput!)

Return fields for enqueuePullRequest

Follow an organization.

Input fields for followOrganization

• input (FollowOrganizationInput!)

Return fields for followOrganization

Follow a user.

Input fields for followUser

• input (FollowUserInput!)

Return fields for followUser