Skip to main content

Deployments

Reference documentation for GraphQL schema types in the Deployments category.

Mutations

approveDeployments

Mutation

Approve all pending deployments under one or more environments.

Input fields for approveDeployments

Return fields for approveDeployments

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

createDeployment

Mutation

Creates a new deployment event.

Input fields for createDeployment

Return fields for createDeployment

NameDescription

autoMerged (Boolean)

True if the default branch has been auto-merged into the deployment ref.

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployment (Deployment)

The new deployment.

createDeploymentStatus

Mutation

Create a deployment status.

Input fields for createDeploymentStatus

Return fields for createDeploymentStatus

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentStatus (DeploymentStatus)

The new deployment status.

createEnvironment

Mutation

Creates an environment or simply returns it if already exists.

Input fields for createEnvironment

Return fields for createEnvironment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The new or existing environment.

deleteDeployment

Mutation

Deletes a deployment.

Input fields for deleteDeployment

Return fields for deleteDeployment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteEnvironment

Mutation

Deletes an environment.

Input fields for deleteEnvironment

Return fields for deleteEnvironment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pinEnvironment

Mutation

Pin an environment to a repository.

Input fields for pinEnvironment

Return fields for pinEnvironment

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The environment that was pinned.

pinnedEnvironment (PinnedEnvironment)

The pinned environment if we pinned.

rejectDeployments

Mutation

Reject all pending deployments under one or more environments.

Input fields for rejectDeployments

Return fields for rejectDeployments

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.