Search
/
Skip to main content
Display menu
Pipelines
Test Analytics
APIs
All APIs
GraphQL API
Console and CLI tutorial
Schema browser
Queries
agent
agentToken
apiAccessTokenCode
artifact
auditEvent
build
graphQLSnippet
job
node
notificationService
organization
organizationInvitation
organizationMember
pipeline
pipelineSchedule
ssoProvider
team
viewer
Mutations
agentStop
agentTokenCreate
agentTokenRevoke
apiAccessTokenCodeAuthorize
buildAnnotate
buildCancel
buildCreate
buildRebuild
emailCreate
emailResendVerification
graphQLSnippetCreate
jobTypeBlockUnblock
jobTypeCommandCancel
jobTypeCommandRetry
noticeDismiss
organizationAPIIPAllowListUpdate
organizationInvitationCreate
organizationInvitationResend
organizationInvitationRevoke
organizationMemberDelete
organizationMemberUpdate
pipelineArchive
pipelineCreate
pipelineCreateWebhook
pipelineDelete
pipelineFavorite
pipelineRotateWebhookURL
pipelineScheduleCreate
pipelineScheduleDelete
pipelineScheduleUpdate
pipelineUnarchive
pipelineUpdate
ssoProviderCreate
ssoProviderDelete
ssoProviderDisable
ssoProviderEnable
ssoProviderUpdate
teamCreate
teamDelete
teamMemberCreate
teamMemberDelete
teamMemberUpdate
teamPipelineCreate
teamPipelineDelete
teamPipelineUpdate
teamSuiteCreate
teamSuiteDelete
teamSuiteUpdate
teamUpdate
totpActivate
totpCreate
totpDelete
totpRecoveryCodesRegenerate
Objects
APIAccessToken
APIAccessTokenCode
APIAccessTokenCodeAuthorizeMutationPayload
APIApplication
Agent
AgentConnection
AgentEdge
AgentPermissions
AgentStopPayload
AgentToken
AgentTokenConnection
AgentTokenCreatePayload
AgentTokenEdge
AgentTokenPermissions
AgentTokenRevokePayload
Annotation
AnnotationBody
AnnotationConnection
AnnotationEdge
Artifact
ArtifactConnection
ArtifactEdge
AuditAPIContext
AuditActor
AuditEvent
AuditSubject
AuditWebContext
AuthorizationBitbucket
AuthorizationConnection
AuthorizationEdge
AuthorizationGitHub
AuthorizationGitHubApp
AuthorizationGitHubEnterprise
AuthorizationGoogle
AuthorizationSAML
Avatar
Build
BuildAnnotatePayload
BuildCancelPayload
BuildConnection
BuildCreatePayload
BuildEdge
BuildMetaData
BuildMetaDataConnection
BuildMetaDataEdge
BuildRebuildPayload
BuildSourceAPI
BuildSourceFrontend
BuildSourceSchedule
BuildSourceTriggerJob
BuildSourceWebhook
BuildStepUpload
BuildStepUploadDefinition
Changelog
ChangelogAuthor
ChangelogConnection
ChangelogEdge
Cluster
ClusterAgentTokenConnection
ClusterAgentTokenEdge
ClusterConnection
ClusterEdge
ClusterPermission
ClusterQueue
ClusterQueueConnection
ClusterQueueEdge
ClusterToken
Dependency
DependencyConnection
DependencyEdge
Dispatch
Email
EmailConnection
EmailCreatePayload
EmailEdge
EmailResendVerificationPayload
GraphQLSnippet
GraphQLSnippetCreatePayload
JobConcurrency
JobConnection
JobEdge
JobEventActor
JobEventAssigned
JobEventBuildStepUploadCreated
JobEventCanceled
JobEventConnection
JobEventEdge
JobEventFinished
JobEventGeneric
JobEventRetried
JobEventTimedOut
JobPriority
JobRetryRuleAutomatic
JobRetryRules
JobTypeBlock
JobTypeBlockUnblockPayload
JobTypeCommand
JobTypeCommandCancelPayload
JobTypeCommandRetryPayload
JobTypeTrigger
JobTypeWait
Mutation
Notice
NoticeDismissPayload
NotificationServiceSlack
NotificationServiceWebhook
OperatingSystem
Organization
OrganizationAPIIPAllowListUpdateMutationPayload
OrganizationAuditEventConnection
OrganizationAuditEventEdge
OrganizationConnection
OrganizationEdge
OrganizationInvitation
OrganizationInvitationConnection
OrganizationInvitationCreatePayload
OrganizationInvitationEdge
OrganizationInvitationPermissions
OrganizationInvitationResendPayload
OrganizationInvitationRevokePayload
OrganizationInvitationSSOType
OrganizationInvitationTeamAssignment
OrganizationInvitationTeamAssignmentConnection
OrganizationInvitationTeamAssignmentEdge
OrganizationMember
OrganizationMemberConnection
OrganizationMemberDeletePayload
OrganizationMemberEdge
OrganizationMemberPermissions
OrganizationMemberPipeline
OrganizationMemberPipelineConnection
OrganizationMemberPipelineEdge
OrganizationMemberSSO
OrganizationMemberSecurity
OrganizationMemberUpdatePayload
OrganizationPermissions
OrganizationSSO
OrganizationSSOProvider
PageInfo
Permission
Pipeline
PipelineArchivePayload
PipelineConnection
PipelineCreatePayload
PipelineCreateWebhookPayload
PipelineDeletePayload
PipelineEdge
PipelineFavoritePayload
PipelineMetric
PipelineMetricConnection
PipelineMetricEdge
PipelinePermissions
PipelineRotateWebhookURLPayload
PipelineSchedule
PipelineScheduleConnection
PipelineScheduleCreatePayload
PipelineScheduleDeletePayload
PipelineScheduleEdge
PipelineSchedulePermissions
PipelineScheduleUpdatePayload
PipelineSteps
PipelineTag
PipelineUnarchivePayload
PipelineUpdatePayload
PullRequest
Query
RecoveryCode
RecoveryCodeBatch
Repository
RepositoryProviderBeanstalk
RepositoryProviderBitbucket
RepositoryProviderBitbucketServer
RepositoryProviderCodebase
RepositoryProviderGithub
RepositoryProviderGithubEnterprise
RepositoryProviderGitlab
RepositoryProviderGitlabCommunity
RepositoryProviderGitlabEnterprise
RepositoryProviderUnknown
SCMPipelineSettings
SCMRepositoryHost
SCMService
SSOAuthorization
SSOAuthorizationConnection
SSOAuthorizationEdge
SSOAuthorizationIdentity
SSOProviderConnection
SSOProviderCreatePayload
SSOProviderDeletePayload
SSOProviderDisablePayload
SSOProviderEdge
SSOProviderEnablePayload
SSOProviderGitHubApp
SSOProviderGoogleGSuite
SSOProviderSAML
SSOProviderSAMLIdPType
SSOProviderSAMLMetadataType
SSOProviderSAMLSPType
SSOProviderUpdatePayload
StepCommand
StepInput
StepTrigger
StepWait
Subscription
Suite
SuiteConnection
SuiteEdge
TOTP
TOTPActivatePayload
TOTPCreatePayload
TOTPDeletePayload
TOTPRecoveryCodesRegeneratePayload
Team
TeamConnection
TeamCreatePayload
TeamDeletePayload
TeamEdge
TeamMember
TeamMemberConnection
TeamMemberCreatePayload
TeamMemberDeletePayload
TeamMemberEdge
TeamMemberPermissions
TeamMemberUpdatePayload
TeamPermissions
TeamPipeline
TeamPipelineConnection
TeamPipelineCreatePayload
TeamPipelineDeletePayload
TeamPipelineEdge
TeamPipelinePermissions
TeamPipelineUpdatePayload
TeamSuite
TeamSuiteConnection
TeamSuiteCreatePayload
TeamSuiteDeletePayload
TeamSuiteEdge
TeamSuitePermissions
TeamSuiteUpdatePayload
TeamUpdatePayload
UnregisteredUser
User
Viewer
ViewerPermissions
__Directive
__EnumValue
__Field
__InputValue
__Schema
__Type
Scalars
Boolean
DateTime
ID
Int
JSInt
JSON
PipelineSelector
String
TeamSelector
UserSelector
XML
YAML
Interfaces
Authorization
BuildSource
Connection
JobEvent
Node
NotificationService
RepositoryProvider
SSOProvider
Step
ENUMs
AnnotationStyle
AuditActorType
AuditEventType
AuditSubjectType
AuthorizationType
BuildBlockedStates
BuildStates
ClusterOrder
ClusterQueueOrder
JobEventActorType
JobEventSignalReason
JobEventType
JobOrder
JobStates
JobTypes
NoticeNamespaces
OrganizationAuditEventOrders
OrganizationInvitationOrders
OrganizationInvitationStates
OrganizationMemberOrder
OrganizationMemberRole
OrganizationMemberSSOModeEnum
PipelineAccessLevels
PipelineOrders
PipelineVisibility
SSOAuthorizationState
SSOProviderSAMLRSAXMLSecurity
SSOProviderSAMLXMLSecurity
SSOProviderStates
SSOProviderTypes
SuiteAccessLevels
SuiteOrders
TeamMemberOrder
TeamMemberRole
TeamOrder
TeamPipelineOrder
TeamPrivacy
TeamSuiteOrder
__DirectiveLocation
__TypeKind
Input objects
APIAccessTokenCodeAuthorizeMutationInput
AgentStopInput
AgentTokenCreateInput
AgentTokenRevokeInput
BuildAnnotateInput
BuildAuthorInput
BuildCancelInput
BuildCreateInput
BuildMetaDataInput
BuildRebuildInput
EmailCreateInput
EmailResendVerificationInput
GraphQLSnippetCreateInput
JobConcurrencySearch
JobPrioritySearch
JobStepSearch
JobTypeBlockUnblockInput
JobTypeCommandCancelInput
JobTypeCommandRetryInput
NoticeDismissInput
OrganizationAPIIPAllowListUpdateMutationInput
OrganizationInvitationCreateInput
OrganizationInvitationResendInput
OrganizationInvitationRevokeInput
OrganizationInvitationSSOInput
OrganizationInvitationTeamAssignmentInput
OrganizationMemberDeleteInput
OrganizationMemberSSOInput
OrganizationMemberSecurityInput
OrganizationMemberUpdateInput
PipelineArchiveInput
PipelineCreateInput
PipelineCreateWebhookInput
PipelineDeleteInput
PipelineFavoriteInput
PipelineRepositoryInput
PipelineRotateWebhookURLInput
PipelineScheduleCreateInput
PipelineScheduleDeleteInput
PipelineScheduleUpdateInput
PipelineStepsInput
PipelineTagInput
PipelineTeamAssignmentInput
PipelineUnarchiveInput
PipelineUpdateInput
SSOProviderCreateInput
SSOProviderDeleteInput
SSOProviderDisableInput
SSOProviderEnableInput
SSOProviderSAMLIdP
SSOProviderSAMLIdPMetadata
SSOProviderUpdateInput
TOTPActivateInput
TOTPCreateInput
TOTPDeleteInput
TOTPRecoveryCodesRegenerateInput
TeamCreateInput
TeamDeleteInput
TeamMemberCreateInput
TeamMemberDeleteInput
TeamMemberUpdateInput
TeamPipelineCreateInput
TeamPipelineDeleteInput
TeamPipelineUpdateInput
TeamSuiteCreateInput
TeamSuiteDeleteInput
TeamSuiteUpdateInput
TeamUpdateInput
Unions
AuditActorNode
AuditContext
AuditSubjectNode
BuildCreator
ClusterPermissionActor
Job
JobEventActorNodeUnion
Cookbook
Integrations
Help
Email support
Forum
Login
Sign up for free
pipelineArchive
PipelineArchivePayload
Archive a pipeline.
Arguments
input
PipelineArchiveInput
Parameters for PipelineArchive
