Mutation OBJECT

The root for mutations in this schema

Fields

agentPauseAgentPausePayload

Pause an agent, preventing dispatch of new jobs but allowing any existing job to finish

Arguments

inputAgentPauseInput!

Parameters for AgentPause

agentResumeAgentResumePayload

Resume a paused agent, allowing it to run jobs again

Arguments

inputAgentResumeInput!

Parameters for AgentResume

agentStopAgentStopPayload

Instruct an agent to stop accepting new build jobs and shut itself down.

Arguments

inputAgentStopInput!

Parameters for AgentStop

agentTokenCreateAgentTokenCreatePayload

Create a new unclustered agent token.

Arguments

inputAgentTokenCreateInput!

Parameters for AgentTokenCreate

agentTokenRevokeAgentTokenRevokePayload

Revoke an unclustered agent token.

Arguments

inputAgentTokenRevokeInput!

Parameters for AgentTokenRevoke

apiAccessTokenCodeAuthorizeAPIAccessTokenCodeAuthorizeMutationPayload

Authorize an API Access Token Code generated by an API Application. Please note this mutation is private and cannot be executed externally.

Arguments

inputAPIAccessTokenCodeAuthorizeMutationInput!

Parameters for APIAccessTokenCodeAuthorizeMutation

buildAnnotateBuildAnnotatePayload

Annotate a build with information to appear on the build page.

Arguments

inputBuildAnnotateInput!

Parameters for BuildAnnotate

buildCancelBuildCancelPayload

Cancel a build.

Arguments

inputBuildCancelInput!

Parameters for BuildCancel

buildCreateBuildCreatePayload

Create a build.

Arguments

inputBuildCreateInput!

Parameters for BuildCreate

buildRebuildBuildRebuildPayload

Rebuild a build.

Arguments

inputBuildRebuildInput!

Parameters for BuildRebuild

clusterAgentTokenCreateClusterAgentTokenCreatePayload

Create an agent token for a cluster.

Arguments

inputClusterAgentTokenCreateInput!

Parameters for ClusterAgentTokenCreate

clusterAgentTokenRevokeClusterAgentTokenRevokePayload

Revokes an agent token for a cluster.

Arguments

inputClusterAgentTokenRevokeInput!

Parameters for ClusterAgentTokenRevoke

clusterAgentTokenUpdateClusterAgentTokenUpdatePayload

Updates an agent token for a cluster.

Arguments

inputClusterAgentTokenUpdateInput!

Parameters for ClusterAgentTokenUpdate

clusterCreateClusterCreatePayload

Create a cluster.

Arguments

inputClusterCreateInput!

Parameters for ClusterCreate

clusterDeleteClusterDeletePayload

Delete a cluster.

Arguments

inputClusterDeleteInput!

Parameters for ClusterDelete

clusterQueueCreateClusterQueueCreatePayload

Create a cluster queue.

Arguments

inputClusterQueueCreateInput!

Parameters for ClusterQueueCreate

clusterQueueDeleteClusterQueueDeletePayload

Delete a cluster queue.

Arguments

inputClusterQueueDeleteInput!

Parameters for ClusterQueueDelete

clusterQueuePauseDispatchClusterQueuePauseDispatchPayload

This will prevent dispatch of jobs to agents on this queue. You can add an optional note describing the reason for pausing.

Arguments

inputClusterQueuePauseDispatchInput!

Parameters for ClusterQueuePauseDispatch

clusterQueueResumeDispatchClusterQueueResumeDispatchPayload

This will resume dispatch of jobs on this queue.

Arguments

inputClusterQueueResumeDispatchInput!

Parameters for ClusterQueueResumeDispatch

clusterQueueUpdateClusterQueueUpdatePayload

Updates a cluster queue.

Arguments

inputClusterQueueUpdateInput!

Parameters for ClusterQueueUpdate

clusterUpdateClusterUpdatePayload

Updates a cluster.

Arguments

inputClusterUpdateInput!

Parameters for ClusterUpdate

emailCreateEmailCreatePayload

Add a new email address for the current user

Arguments

inputEmailCreateInput!

Parameters for EmailCreate

emailResendVerificationEmailResendVerificationPayload

Resend a verification email.

Arguments

inputEmailResendVerificationInput!

Parameters for EmailResendVerification

graphQLSnippetCreateGraphQLSnippetCreatePayload

Create a GraphQL snippet.

Arguments

inputGraphQLSnippetCreateInput!

Parameters for GraphQLSnippetCreate

jobTypeBlockUnblockJobTypeBlockUnblockPayload

Unblocks a build's "Block pipeline" job.

Arguments

inputJobTypeBlockUnblockInput!

Parameters for JobTypeBlockUnblock

jobTypeCommandCancelJobTypeCommandCancelPayload

Cancel a job.

Arguments

inputJobTypeCommandCancelInput!

Parameters for JobTypeCommandCancel

jobTypeCommandRetryJobTypeCommandRetryPayload

Retry a job.

Arguments

inputJobTypeCommandRetryInput!

Parameters for JobTypeCommandRetry

noticeDismissNoticeDismissPayload

Dismisses a notice from the Buildkite UI. This mutation is idempotent so if you dismiss the same notice multiple times, it will return the original dismissedAt time

Arguments

inputNoticeDismissInput!

Parameters for NoticeDismiss

organizationApiAccessTokenRevokeOrganizationAPIAccessTokenRevokeMutationPayload

Revokes access to an organization for a user's API access token. The organization can not be re-added to the same token, however the user can create a new token and add the organization to that token.

Arguments

inputOrganizationAPIAccessTokenRevokeMutationInput!

Parameters for OrganizationAPIAccessTokenRevokeMutation

organizationApiIpAllowlistUpdateOrganizationAPIIPAllowlistUpdateMutationPayload

Sets an allowlist of IP addresses for API access to an organization. Please note that this is a beta feature and is not yet available to all organizations.

Arguments

inputOrganizationAPIIPAllowlistUpdateMutationInput!

Parameters for OrganizationAPIIPAllowlistUpdateMutation

organizationBannerDeleteOrganizationBannerDeletePayload

Delete the system banner

Arguments

inputOrganizationBannerDeleteInput!

Parameters for OrganizationBannerDelete

organizationBannerUpsertOrganizationBannerUpsertPayload

Retrieves the active system banner for provided organization, then updates it with input data. If active banner is not found, a new banner is created with the provided input.

Arguments

inputOrganizationBannerUpsertInput!

Parameters for OrganizationBannerUpsert

organizationEnforceTwoFactorAuthenticationForMembersUpdateOrganizationEnforceTwoFactorAuthenticationForMembersUpdateMutationPayload

Sets whether the organization requires two-factor authentication for all members.

Arguments

inputOrganizationEnforceTwoFactorAuthenticationForMembersUpdateMutationInput!

Parameters for OrganizationEnforceTwoFactorAuthenticationForMembersUpdateMutation

organizationInvitationCreateOrganizationInvitationCreatePayload

Send email invitations to this organization.

Arguments

inputOrganizationInvitationCreateInput!

Parameters for OrganizationInvitationCreate

organizationInvitationResendOrganizationInvitationResendPayload

Resend an organization invitation email.

Arguments

inputOrganizationInvitationResendInput!

Parameters for OrganizationInvitationResend

organizationInvitationRevokeOrganizationInvitationRevokePayload

Revoke an invitation to an organization so that it can no longer be accepted.

Arguments

inputOrganizationInvitationRevokeInput!

Parameters for OrganizationInvitationRevoke

organizationMemberDeleteOrganizationMemberDeletePayload

Remove a user from an organization.

Arguments

inputOrganizationMemberDeleteInput!

Parameters for OrganizationMemberDelete

organizationMemberUpdateOrganizationMemberUpdatePayload

Change a user's role within an organization.

Arguments

inputOrganizationMemberUpdateInput!

Parameters for OrganizationMemberUpdate

organizationRevokeInactiveTokensAfterUpdateOrganizationRevokeInactiveTokensAfterUpdateMutationPayload

Specify the maximum timeframe to revoke organization access from inactive API tokens.

Arguments

inputOrganizationRevokeInactiveTokensAfterUpdateMutationInput!

Parameters for OrganizationRevokeInactiveTokensAfterUpdateMutation

pipelineArchivePipelineArchivePayload

Archive a pipeline.

Arguments

inputPipelineArchiveInput!

Parameters for PipelineArchive

pipelineCreatePipelineCreatePayload

Create a pipeline.

Arguments

inputPipelineCreateInput!

Parameters for PipelineCreate

pipelineCreateWebhookPipelineCreateWebhookPayload

Create SCM webhooks for a pipeline.

Arguments

inputPipelineCreateWebhookInput!

Parameters for PipelineCreateWebhook

pipelineDeletePipelineDeletePayload

Delete a pipeline.

Arguments

inputPipelineDeleteInput!

Parameters for PipelineDelete

pipelineFavoritePipelineFavoritePayload

Favorite a pipeline.

Arguments

inputPipelineFavoriteInput!

Parameters for PipelineFavorite

pipelineRotateWebhookURLPipelineRotateWebhookURLPayload

Rotate a pipeline's webhook URL. Note that the old webhook URL will stop working immediately and so must be updated quickly to avoid interruption.

Arguments

inputPipelineRotateWebhookURLInput!

Parameters for PipelineRotateWebhookURL

pipelineScheduleCreatePipelineScheduleCreatePayload

Create a scheduled build on pipeline.

Arguments

inputPipelineScheduleCreateInput!

Parameters for PipelineScheduleCreate

pipelineScheduleDeletePipelineScheduleDeletePayload

Delete a scheduled build on pipeline.

Arguments

inputPipelineScheduleDeleteInput!

Parameters for PipelineScheduleDelete

pipelineScheduleUpdatePipelineScheduleUpdatePayload

Update a scheduled build on pipeline.

Arguments

inputPipelineScheduleUpdateInput!

Parameters for PipelineScheduleUpdate

pipelineTemplateCreatePipelineTemplateCreatePayload

Create a pipeline template.

Arguments

inputPipelineTemplateCreateInput!

Parameters for PipelineTemplateCreate

pipelineTemplateDeletePipelineTemplateDeletePayload

Delete a pipeline template.

Arguments

inputPipelineTemplateDeleteInput!

Parameters for PipelineTemplateDelete

pipelineTemplateUpdatePipelineTemplateUpdatePayload

Update a pipeline template.

Arguments

inputPipelineTemplateUpdateInput!

Parameters for PipelineTemplateUpdate

pipelineUnarchivePipelineUnarchivePayload

Unarchive a pipeline.

Arguments

inputPipelineUnarchiveInput!

Parameters for PipelineUnarchive

pipelineUpdatePipelineUpdatePayload

Change the settings for a pipeline.

Arguments

inputPipelineUpdateInput!

Parameters for PipelineUpdate

ruleCreateRuleCreatePayload

Create a rule.

Arguments

inputRuleCreateInput!

Parameters for RuleCreate

ruleDeleteRuleDeletePayload

Delete a rule.

Arguments

inputRuleDeleteInput!

Parameters for RuleDelete

ruleUpdateRuleUpdatePayload

Update a rule.

Arguments

inputRuleUpdateInput!

Parameters for RuleUpdate

ssoProviderCreateSSOProviderCreatePayload

Create a SSO provider.

Arguments

inputSSOProviderCreateInput!

Parameters for SSOProviderCreate

ssoProviderDeleteSSOProviderDeletePayload

Delete a SSO provider.

Arguments

inputSSOProviderDeleteInput!

Parameters for SSOProviderDelete

ssoProviderDisableSSOProviderDisablePayload

Disable a SSO provider.

Arguments

inputSSOProviderDisableInput!

Parameters for SSOProviderDisable

ssoProviderEnableSSOProviderEnablePayload

Enable a SSO provider.

Arguments

inputSSOProviderEnableInput!

Parameters for SSOProviderEnable

ssoProviderUpdateSSOProviderUpdatePayload

Change the settings for a SSO provider.

Arguments

inputSSOProviderUpdateInput!

Parameters for SSOProviderUpdate

teamCreateTeamCreatePayload

Create a team.

Arguments

inputTeamCreateInput!

Parameters for TeamCreate

teamDeleteTeamDeletePayload

Delete a team.

Arguments

inputTeamDeleteInput!

Parameters for TeamDelete

teamMemberCreateTeamMemberCreatePayload

Add a user to a team.

Arguments

inputTeamMemberCreateInput!

Parameters for TeamMemberCreate

teamMemberDeleteTeamMemberDeletePayload

Remove a user from a team.

Arguments

inputTeamMemberDeleteInput!

Parameters for TeamMemberDelete

teamMemberUpdateTeamMemberUpdatePayload

Update a user's role in a team.

Arguments

inputTeamMemberUpdateInput!

Parameters for TeamMemberUpdate

teamPipelineCreateTeamPipelineCreatePayload

Add a pipeline to a team.

Arguments

inputTeamPipelineCreateInput!

Parameters for TeamPipelineCreate

teamPipelineDeleteTeamPipelineDeletePayload

Remove a pipeline from a team.

Arguments

inputTeamPipelineDeleteInput!

Parameters for TeamPipelineDelete

teamPipelineUpdateTeamPipelineUpdatePayload

Update a pipeline's access level within a team.

Arguments

inputTeamPipelineUpdateInput!

Parameters for TeamPipelineUpdate

teamRegistryCreateTeamRegistryCreatePayload

Add a registry to a team.

Arguments

inputTeamRegistryCreateInput!

Parameters for TeamRegistryCreate

teamRegistryDeleteTeamRegistryDeletePayload

Remove a registry from a team.

Arguments

inputTeamRegistryDeleteInput!

Parameters for TeamRegistryDelete

teamRegistryUpdateTeamRegistryUpdatePayload

Update a registry's access level within a team.

Arguments

inputTeamRegistryUpdateInput!

Parameters for TeamRegistryUpdate

teamSuiteCreateTeamSuiteCreatePayload

Add a suite to a team.

Arguments

inputTeamSuiteCreateInput!

Parameters for TeamSuiteCreate

teamSuiteDeleteTeamSuiteDeletePayload

Remove a suite from a team.

Arguments

inputTeamSuiteDeleteInput!

Parameters for TeamSuiteDelete

teamSuiteUpdateTeamSuiteUpdatePayload

Update a suite's access level within a team.

Arguments

inputTeamSuiteUpdateInput!

Parameters for TeamSuiteUpdate

teamUpdateTeamUpdatePayload

Change the settings for a team.

Arguments

inputTeamUpdateInput!

Parameters for TeamUpdate

totpActivateTOTPActivatePayload

Activate a previously-generated TOTP configuration, and its Recovery Codes. Once activated, both this TOTP configuration, and the associated Recovery Codes will become active for the user. Any previous TOTP configuration or Recovery Codes will no longer be usable. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.

Arguments

inputTOTPActivateInput!

Parameters for TOTPActivate

totpCreateTOTPCreatePayload

Create a new TOTP configuration for the current user. This will produce a TOTP configuration with an associated set of Recovery Codes. The Recovery Codes must be presented to the user prior to the TOTP's activation with totpActivate. Neither TOTP configuration nor Recovery Codes will be usable until they have been activated. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.

Arguments

inputTOTPCreateInput!

Parameters for TOTPCreate

totpDeleteTOTPDeletePayload

Delete a TOTP configuration. If a TOTP configuration was active, it will no longer be used for logging on to the user's account. Any Recovery Codes associated with the TOTP configuration will also no longer be usable. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.

Arguments

inputTOTPDeleteInput!

Parameters for TOTPDelete

totpRecoveryCodesRegenerateTOTPRecoveryCodesRegeneratePayload

Generate a new set of Recovery Codes for a given TOTP. The new Recovery Codes will immediately replace any existing recovery codes. This mutation is private, requires an escalated session, and cannot be accessed via the public GraphQL API.

Arguments

inputTOTPRecoveryCodesRegenerateInput!

Parameters for TOTPRecoveryCodesRegenerate