Mutation OBJECT

The root for mutations in this schema

Fields

agentStopAgentStopPayload

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

Arguments

inputAgentStopInputrequired

agentTokenCreateAgentTokenCreatePayload

Create a new agent registration token.

Arguments

inputAgentTokenCreateInputrequired

agentTokenRevokeAgentTokenRevokePayload

Revoke an agent registration token.

Arguments

inputAgentTokenRevokeInputrequired

apiAccessTokenCodeAuthorizeAPIAccessTokenCodeAuthorizeMutationPayload

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

buildAnnotateBuildAnnotatePayload

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

Arguments

inputBuildAnnotateInputrequired

buildCancelBuildCancelPayload

Cancel a build.

Arguments

inputBuildCancelInputrequired

buildCreateBuildCreatePayload

Create a build.

Arguments

inputBuildCreateInputrequired

buildRebuildBuildRebuildPayload

Rebuild a build.

Arguments

inputBuildRebuildInputrequired

emailCreateEmailCreatePayload

Add a new email address for the current user

Arguments

inputEmailCreateInputrequired

emailResendVerificationEmailResendVerificationPayload

Resend a verification email.

Arguments

inputEmailResendVerificationInputrequired

graphQLSnippetCreateGraphQLSnippetCreatePayload

Create a GraphQL snippet.

Arguments

inputGraphQLSnippetCreateInputrequired

jobTypeBlockUnblockJobTypeBlockUnblockPayload

Unblocks a build's "Block pipeline" job.

Arguments

inputJobTypeBlockUnblockInputrequired

jobTypeCommandCancelJobTypeCommandCancelPayload

Cancel a job.

Arguments

inputJobTypeCommandCancelInputrequired

jobTypeCommandRetryJobTypeCommandRetryPayload

Retry a job.

Arguments

inputJobTypeCommandRetryInputrequired

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

inputNoticeDismissInputrequired

organizationInvitationCreateOrganizationInvitationCreatePayload

Send email invitations to this organization.

Arguments

inputOrganizationInvitationCreateInputrequired

organizationInvitationResendOrganizationInvitationResendPayload

Resend an organization invitation email.

Arguments

inputOrganizationInvitationResendInputrequired

organizationInvitationRevokeOrganizationInvitationRevokePayload

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

Arguments

inputOrganizationInvitationRevokeInputrequired

organizationMemberDeleteOrganizationMemberDeletePayload

Remove a user from an organization.

Arguments

inputOrganizationMemberDeleteInputrequired

organizationMemberUpdateOrganizationMemberUpdatePayload

Change a user's role within an organization.

Arguments

inputOrganizationMemberUpdateInputrequired

pipelineArchivePipelineArchivePayload

Archive a pipeline.

Arguments

inputPipelineArchiveInputrequired

pipelineCreatePipelineCreatePayload

Create a pipeline.

Arguments

inputPipelineCreateInputrequired

pipelineCreateWebhookPipelineCreateWebhookPayload

Create SCM webhooks for a pipeline.

Arguments

inputPipelineCreateWebhookInputrequired

pipelineDeletePipelineDeletePayload

Delete a pipeline.

Arguments

inputPipelineDeleteInputrequired

pipelineFavoritePipelineFavoritePayload

Favorite a pipeline.

Arguments

inputPipelineFavoriteInputrequired

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

inputPipelineRotateWebhookURLInputrequired

pipelineScheduleCreatePipelineScheduleCreatePayload

Create a scheduled build on pipeline.

Arguments

inputPipelineScheduleCreateInputrequired

pipelineScheduleDeletePipelineScheduleDeletePayload

Delete a scheduled build on pipeline.

Arguments

inputPipelineScheduleDeleteInputrequired

pipelineScheduleUpdatePipelineScheduleUpdatePayload

Update a scheduled build on pipeline.

Arguments

inputPipelineScheduleUpdateInputrequired

pipelineUnarchivePipelineUnarchivePayload

Unarchive a pipeline.

Arguments

inputPipelineUnarchiveInputrequired

pipelineUpdatePipelineUpdatePayload

Change the settings for a pipeline.

Arguments

inputPipelineUpdateInputrequired

ssoProviderCreateSSOProviderCreatePayload

Create a SSO provider.

Arguments

inputSSOProviderCreateInputrequired

ssoProviderDeleteSSOProviderDeletePayload

Delete a SSO provider.

Arguments

inputSSOProviderDeleteInputrequired

ssoProviderDisableSSOProviderDisablePayload

Disable a SSO provider.

Arguments

inputSSOProviderDisableInputrequired

ssoProviderEnableSSOProviderEnablePayload

Enable a SSO provider.

Arguments

inputSSOProviderEnableInputrequired

ssoProviderUpdateSSOProviderUpdatePayload

Change the settings for a SSO provider.

Arguments

inputSSOProviderUpdateInputrequired

teamCreateTeamCreatePayload

Create a team.

Arguments

inputTeamCreateInputrequired

teamDeleteTeamDeletePayload

Delete a team.

Arguments

inputTeamDeleteInputrequired

teamMemberCreateTeamMemberCreatePayload

Add a user to a team.

Arguments

inputTeamMemberCreateInputrequired

teamMemberDeleteTeamMemberDeletePayload

Remove a user from a team.

Arguments

inputTeamMemberDeleteInputrequired

teamMemberUpdateTeamMemberUpdatePayload

Update a user's role in a team.

Arguments

inputTeamMemberUpdateInputrequired

teamPipelineCreateTeamPipelineCreatePayload

Add a pipeline to a team.

Arguments

inputTeamPipelineCreateInputrequired

teamPipelineDeleteTeamPipelineDeletePayload

Remove a pipeline from a team.

Arguments

inputTeamPipelineDeleteInputrequired

teamPipelineUpdateTeamPipelineUpdatePayload

Update a pipeline's access level within a team.

Arguments

inputTeamPipelineUpdateInputrequired

teamSuiteCreateTeamSuiteCreatePayload

Add a suite to a team.

Arguments

inputTeamSuiteCreateInputrequired

teamSuiteDeleteTeamSuiteDeletePayload

Remove a suite from a team.

Arguments

inputTeamSuiteDeleteInputrequired

teamSuiteUpdateTeamSuiteUpdatePayload

Update a suite's access level within a team.

Arguments

inputTeamSuiteUpdateInputrequired

teamUpdateTeamUpdatePayload

Change the settings for a team.

Arguments

inputTeamUpdateInputrequired

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

inputTOTPActivateInputrequired

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

inputTOTPCreateInputrequired

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

inputTOTPDeleteInputrequired

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

inputTOTPRecoveryCodesRegenerateInputrequired