This version of GitHub Enterprise Server was discontinued on 2025-06-19. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.

Input objects

Input objects can be described as "composable objects" because they include a set of input fields that define the object.

In this article

About input objects

Input objects can be described as "composable objects" because they include a set of input fields that define the object.

For example, CommitAuthor takes a field called emails. Providing a value for emails transforms CommitAuthor into a list of User objects containing that email address. Note that objects may have input objects, whereas mutations require input objects.

For more information, see Forming calls with GraphQL.

AbortQueuedMigrationsInput

Autogenerated input type of AbortQueuedMigrations.

Input fields for AbortQueuedMigrationsInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the organization that is running the migrations.

AbortRepositoryMigrationInput

Autogenerated input type of AbortRepositoryMigration.

Input fields for AbortRepositoryMigrationInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

migrationId (ID!)

The ID of the migration to be aborted.

AddAssigneesToAssignableInput

Autogenerated input type of AddAssigneesToAssignable.

Input fields for AddAssigneesToAssignableInput

NameDescription

assignableId (ID!)

The id of the assignable object to add assignees to.

assigneeIds ([ID!]!)

The id of users to add as assignees.

clientMutationId (String)

A unique identifier for the client performing the mutation.

AddCommentInput

Autogenerated input type of AddComment.

Input fields for AddCommentInput

NameDescription

body (String!)

The contents of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the subject to modify.

AddDiscussionCommentInput

Autogenerated input type of AddDiscussionComment.

Input fields for AddDiscussionCommentInput

NameDescription

body (String!)

The contents of the comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussionId (ID!)

The Node ID of the discussion to comment on.

replyToId (ID)

The Node ID of the discussion comment within this discussion to reply to.

AddDiscussionPollVoteInput

Autogenerated input type of AddDiscussionPollVote.

Input fields for AddDiscussionPollVoteInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pollOptionId (ID!)

The Node ID of the discussion poll option to vote for.

AddEnterpriseAdminInput

Autogenerated input type of AddEnterpriseAdmin.

Input fields for AddEnterpriseAdminInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise account to which the administrator should be added.

login (String!)

The login of the user to add as an administrator.

AddEnterpriseOrganizationMemberInput

Autogenerated input type of AddEnterpriseOrganizationMember.

Input fields for AddEnterpriseOrganizationMemberInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterpriseId (ID!)

The ID of the enterprise which owns the organization.

organizationId (ID!)

The ID of the organization the users will be added to.

role (OrganizationMemberRole)

The role to assign the users in the organization.

userIds ([ID!]!)

The IDs of the enterprise members to add.

AddLabelsToLabelableInput

Autogenerated input type of AddLabelsToLabelable.

Input fields for AddLabelsToLabelableInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelIds ([ID!]!)

The ids of the labels to add.

labelableId (ID!)

The id of the labelable object to add labels to.

AddProjectCardInput

Autogenerated input type of AddProjectCard.

Input fields for AddProjectCardInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

note (String)

The note on the card.

projectColumnId (ID!)

The Node ID of the ProjectColumn.

AddProjectColumnInput

Autogenerated input type of AddProjectColumn.

Input fields for AddProjectColumnInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of the column.

projectId (ID!)

The Node ID of the project.

AddProjectV2DraftIssueInput

Autogenerated input type of AddProjectV2DraftIssue.

Input fields for AddProjectV2DraftIssueInput

NameDescription

assigneeIds ([ID!])

The IDs of the assignees of the draft issue.

body (String)

The body of the draft issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to add the draft issue to.

title (String!)

The title of the draft issue. A project item can also be created by providing the URL of an Issue or Pull Request if you have access.

AddProjectV2ItemByIdInput

Autogenerated input type of AddProjectV2ItemById.

Input fields for AddProjectV2ItemByIdInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID!)

The id of the Issue or Pull Request to add.

projectId (ID!)

The ID of the Project to add the item to.

AddPullRequestReviewCommentInput

Autogenerated input type of AddPullRequestReviewComment.

Input fields for AddPullRequestReviewCommentInput

NameDescription

body (String)

The text of the comment. This field is required

Upcoming Change on 2023-10-01 UTC Description: body will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

clientMutationId (String)

A unique identifier for the client performing the mutation.

commitOID (GitObjectID)

The SHA of the commit to comment on.

Upcoming Change on 2023-10-01 UTC Description: commitOID will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

inReplyTo (ID)

The comment id to reply to.

Upcoming Change on 2023-10-01 UTC Description: inReplyTo will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

path (String)

The relative path of the file to comment on.

Upcoming Change on 2023-10-01 UTC Description: path will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

position (Int)

The line index in the diff to comment on.

Upcoming Change on 2023-10-01 UTC Description: position will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

pullRequestId (ID)

The node ID of the pull request reviewing

Upcoming Change on 2023-10-01 UTC Description: pullRequestId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

pullRequestReviewId (ID)

The Node ID of the review to modify.

Upcoming Change on 2023-10-01 UTC Description: pullRequestReviewId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead Reason: We are deprecating the addPullRequestReviewComment mutation.

AddPullRequestReviewInput

Autogenerated input type of AddPullRequestReview.

Input fields for AddPullRequestReviewInput

NameDescription

body (String)

The contents of the review body comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

comments ([DraftPullRequestReviewComment])

The review line comments.

Upcoming Change on 2023-10-01 UTC Description: comments will be removed. use the threads argument instead Reason: We are deprecating comment fields that use diff-relative positioning.

commitOID (GitObjectID)

The commit OID the review pertains to.

event (PullRequestReviewEvent)

The event to perform on the pull request review.

pullRequestId (ID!)

The Node ID of the pull request to modify.

threads ([DraftPullRequestReviewThread])

The review line comment threads.

AddPullRequestReviewThreadInput

Autogenerated input type of AddPullRequestReviewThread.

Input fields for AddPullRequestReviewThreadInput

NameDescription

body (String!)

Body of the thread's first comment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

line (Int)

The line of the blob to which the thread refers, required for line-level threads. The end of the line range for multi-line comments.

path (String!)

Path to the file being commented on.

pullRequestId (ID)

The node ID of the pull request reviewing.

pullRequestReviewId (ID)

The Node ID of the review to modify.

side (DiffSide)

The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

startLine (Int)

The first line of the range to which the comment refers.

startSide (DiffSide)

The side of the diff on which the start line resides.

subjectType (PullRequestReviewThreadSubjectType)

The level at which the comments in the corresponding thread are targeted, can be a diff line or a file.

AddPullRequestReviewThreadReplyInput

Autogenerated input type of AddPullRequestReviewThreadReply.

Input fields for AddPullRequestReviewThreadReplyInput

NameDescription

body (String!)

The text of the reply.

clientMutationId (String)

A unique identifier for the client performing the mutation.

pullRequestReviewId (ID)

The Node ID of the pending review to which the reply will belong.

pullRequestReviewThreadId (ID!)

The Node ID of the thread to which this reply is being written.

AddReactionInput

Autogenerated input type of AddReaction.

Input fields for AddReactionInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

content (ReactionContent!)

The name of the emoji to react with.

subjectId (ID!)

The Node ID of the subject to modify.

AddStarInput

Autogenerated input type of AddStar.

Input fields for AddStarInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to star.

AddUpvoteInput

Autogenerated input type of AddUpvote.

Input fields for AddUpvoteInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

subjectId (ID!)

The Node ID of the discussion or comment to upvote.

AddVerifiableDomainInput

Autogenerated input type of AddVerifiableDomain.

Input fields for AddVerifiableDomainInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

domain (URI!)

The URL of the domain.

ownerId (ID!)

The ID of the owner to add the domain to.

ApproveDeploymentsInput

Autogenerated input type of ApproveDeployments.

Input fields for ApproveDeploymentsInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (String)

Optional comment for approving deployments.

environmentIds ([ID!]!)

The ids of environments to reject deployments.

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

ApproveVerifiableDomainInput

Autogenerated input type of ApproveVerifiableDomain.

Input fields for ApproveVerifiableDomainInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The ID of the verifiable domain to approve.

ArchiveProjectV2ItemInput

Autogenerated input type of ArchiveProjectV2Item.

Input fields for ArchiveProjectV2ItemInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

itemId (ID!)

The ID of the ProjectV2Item to archive.

projectId (ID!)

The ID of the Project to archive the item from.

ArchiveRepositoryInput

Autogenerated input type of ArchiveRepository.

Input fields for ArchiveRepositoryInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repositoryId (ID!)

The ID of the repository to mark as archived.

AuditLogOrder

Ordering options for Audit Log connections.

Input fields for AuditLogOrder

NameDescription

direction (OrderDirection)

The ordering direction.

field (AuditLogOrderField)

The field to order Audit Logs by.

BranchNamePatternParametersInput

Parameters to be used for the branch_name_pattern rule.

Input fields for BranchNamePatternParametersInput

NameDescription

name (String)

How this rule will appear to users.

negate (Boolean)

If true, the rule will fail if the pattern matches.

operator (String!)

The operator to use for matching.

pattern (String!)

The pattern to match with.

ChangeUserStatusInput

Autogenerated input type of ChangeUserStatus.

Input fields for ChangeUserStatusInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

emoji (String)

The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

expiresAt (DateTime)

If set, the user status will not be shown after this date.

limitedAvailability (Boolean)

Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

message (String)

A short description of your current status.

organizationId (ID)

The ID of the organization whose members will be allowed to see the status. If omitted, the status will be publicly visible.

CheckAnnotationData

Information from a check run analysis to specific lines of code.

Input fields for CheckAnnotationData

NameDescription

annotationLevel (CheckAnnotationLevel!)

Represents an annotation's information level.

location (CheckAnnotationRange!)

The location of the annotation.

message (String!)

A short description of the feedback for these lines of code.

path (String!)

The path of the file to add an annotation to.

rawDetails (String)

Details about this annotation.

title (String)

The title that represents the annotation.

CheckAnnotationRange

Information from a check run analysis to specific lines of code.

Input fields for CheckAnnotationRange

NameDescription

endColumn (Int)

The ending column of the range.

endLine (Int!)

The ending line of the range.

startColumn (Int)

The starting column of the range.

startLine (Int!)

The starting line of the range.

CheckRunAction

Possible further actions the integrator can perform.

Input fields for CheckRunAction

NameDescription

description (String!)

A short explanation of what this action would do.

identifier (String!)

A reference for the action on the integrator's system.

label (String!)

The text to be displayed on a button in the web UI.

CheckRunFilter

The filters that are available when fetching check runs.

Input fields for CheckRunFilter

NameDescription

appId (Int)

Filters the check runs created by this application ID.

checkName (String)

Filters the check runs by this name.

checkType (CheckRunType)

Filters the check runs by this type.

conclusions ([CheckConclusionState!])

Filters the check runs by these conclusions.

status (CheckStatusState)

Filters the check runs by this status. Superceded by statuses.

statuses ([CheckStatusState!])

Filters the check runs by this status. Overrides status.

CheckRunOutput

Descriptive details about the check run.

Input fields for CheckRunOutput

NameDescription

annotations ([CheckAnnotationData!])

The annotations that are made as part of the check run.

images ([CheckRunOutputImage!])

Images attached to the check run output displayed in the GitHub pull request UI.

summary (String!)

The summary of the check run (supports Commonmark).

text (String)

The details of the check run (supports Commonmark).

title (String!)

A title to provide for this check run.

CheckRunOutputImage

Images attached to the check run output displayed in the GitHub pull request UI.

Input fields for CheckRunOutputImage

NameDescription

alt (String!)

The alternative text for the image.

caption (String)

A short image description.

imageUrl (URI!)

The full URL of the image.

CheckSuiteAutoTriggerPreference

The auto-trigger preferences that are available for check suites.

Input fields for CheckSuiteAutoTriggerPreference

NameDescription

appId (ID!)

The node ID of the application that owns the check suite.

setting (Boolean!)

Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

CheckSuiteFilter

The filters that are available when fetching check suites.

Input fields for CheckSuiteFilter

NameDescription

appId (Int)

Filters the check suites created by this application ID.

checkName (String)

Filters the check suites by this name.

ClearLabelsFromLabelableInput

Autogenerated input type of ClearLabelsFromLabelable.

Input fields for ClearLabelsFromLabelableInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

labelableId (ID!)

The id of the labelable object to clear the labels from.

ClearProjectV2ItemFieldValueInput

Autogenerated input type of ClearProjectV2ItemFieldValue.

Input fields for ClearProjectV2ItemFieldValueInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

fieldId (ID!)

The ID of the field to be cleared.

itemId (ID!)

The ID of the item to be cleared.

projectId (ID!)

The ID of the Project.

CloneProjectInput

Autogenerated input type of CloneProject.

Input fields for CloneProjectInput

NameDescription

body (String)

The description of the project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

name (String!)

The name of the project.

public (Boolean)

The visibility of the project, defaults to false (private).

sourceId (ID!)

The source project to clone.

targetOwnerId (ID!)

The owner ID to create the project under.

CloneTemplateRepositoryInput

Autogenerated input type of CloneTemplateRepository.

Input fields for CloneTemplateRepositoryInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

A short description of the new repository.