Deployments

Mutations

approveDeployments

Mutation

Approve all pending deployments under one or more environments.

Input fields for `approveDeployments`

input (ApproveDeploymentsInput!)

Return fields for `approveDeployments`

Name	Description
`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`

input (CreateDeploymentInput!)

Return fields for `createDeployment`

Name	Description
`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`

input (CreateDeploymentStatusInput!)

Return fields for `createDeploymentStatus`

Name	Description
`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`

input (CreateEnvironmentInput!)

Return fields for `createEnvironment`

Name	Description
`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`

input (DeleteDeploymentInput!)

Return fields for `deleteDeployment`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.

deleteEnvironment

Mutation

Deletes an environment.

Input fields for `deleteEnvironment`

input (DeleteEnvironmentInput!)

Return fields for `deleteEnvironment`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.

pinEnvironment

Mutation

Pin an environment to a repository.

Input fields for `pinEnvironment`

input (PinEnvironmentInput!)

Return fields for `pinEnvironment`

Name	Description
`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`

input (RejectDeploymentsInput!)

Return fields for `rejectDeployments`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`deployments` (`[Deployment!]`)	The affected deployments.

reorderEnvironment

Mutation

Reorder a pinned repository environment.

Input fields for `reorderEnvironment`

input (ReorderEnvironmentInput!)

Return fields for `reorderEnvironment`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`environment` (`Environment`)	The environment that was reordered.

updateEnvironment

Mutation

Updates an environment.

Input fields for `updateEnvironment`

input (UpdateEnvironmentInput!)

Return fields for `updateEnvironment`

Name	Description
`clientMutationId` (`String`)	A unique identifier for the client performing the mutation.
`environment` (`Environment`)	The updated environment.

Objects

DeployedEvent

Object

Represents adeployedevent on a given pull request.

`DeployedEvent` Implements

Node

Fields for `DeployedEvent`

Name	Description
`actor` (`Actor`)	Identifies the actor who performed the event.
`createdAt` (`DateTime!`)	Identifies the date and time when the object was created.
`databaseId` (`Int`)	Identifies the primary key from the database.
`deployment` (`Deployment!`)	The deployment associated with the`deployed`event.
`id` (`ID!`)	The Node ID of the DeployedEvent object.
`pullRequest` (`PullRequest!`)	PullRequest referenced by event.
`ref` (`Ref`)	The ref associated with the`deployed`event.

Deployment

Object

Represents triggered deployment instance.

`Deployment` Implements

Node

Fields for `Deployment`

Name	Description
`commit` (`Commit`)	Identifies the commit sha of the deployment.
`commitOid` (`String!`)	Identifies the oid of the deployment commit, even if the commit has been deleted.
`createdAt` (`DateTime!`)	Identifies the date and time when the object was created.
`creator` (`Actor!`)	Identifies the actor who triggered the deployment.
`databaseId` (`Int`)	Identifies the primary key from the database.
`description` (`String`)	The deployment description.
`environment` (`String`)	The latest environment to which this deployment was made.
`id` (`ID!`)	The Node ID of the Deployment object.
`latestEnvironment` (`String`)	The latest environment to which this deployment was made.
`latestStatus` (`DeploymentStatus`)	The latest status of this deployment.
`originalEnvironment` (`String`)	The original environment to which this deployment was made.
`payload` (`String`)	Extra information that a deployment system might need.
`ref` (`Ref`)	Identifies the Ref of the deployment, if the deployment was created by ref.
`repository` (`Repository!`)	Identifies the repository associated with the deployment.
`state` (`DeploymentState`)	The current state of the deployment.
`statuses` (`DeploymentStatusConnection`)	A list of statuses associated with the deployment. Arguments for `statuses` `after` (`String`) Returns the elements in the list that come after the specified cursor. `before` (`String`) Returns the elements in the list that come before the specified cursor. `first` (`Int`) Returns the first n elements from the list. `last` (`Int`) Returns the last n elements from the list.
`task` (`String`)	The deployment task.
`updatedAt` (`DateTime!`)	Identifies the date and time when the object was last updated.

DeploymentConnection

Object

The connection type for Deployment.

Fields for `DeploymentConnection`

Name	Description
`edges` (`[DeploymentEdge]`)	A list of edges.
`nodes` (`[Deployment]`)	A list of nodes.
`pageInfo` (`PageInfo!`)	Information to aid in pagination.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

DeploymentEdge

Object

An edge in a connection.

Fields for `DeploymentEdge`

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (`Deployment`)	The item at the end of the edge.

DeploymentEnvironmentChangedEvent

Object

Represents adeployment_environment_changedevent on a given pull request.

`DeploymentEnvironmentChangedEvent` Implements

Node

Fields for `DeploymentEnvironmentChangedEvent`

Name	Description
`actor` (`Actor`)	Identifies the actor who performed the event.
`createdAt` (`DateTime!`)	Identifies the date and time when the object was created.
`deploymentStatus` (`DeploymentStatus!`)	The deployment status that updated the deployment environment.
`id` (`ID!`)	The Node ID of the DeploymentEnvironmentChangedEvent object.
`pullRequest` (`PullRequest!`)	PullRequest referenced by event.

DeploymentProtectionRule

Object

A protection rule.

Fields for `DeploymentProtectionRule`

Name	Description
`databaseId` (`Int`)	Identifies the primary key from the database.
`preventSelfReview` (`Boolean`)	Whether deployments to this environment can be approved by the user who created the deployment.
`reviewers` (`DeploymentReviewerConnection!`)	The teams or users that can review the deployment. Arguments for `reviewers` `after` (`String`) Returns the elements in the list that come after the specified cursor. `before` (`String`) Returns the elements in the list that come before the specified cursor. `first` (`Int`) Returns the first n elements from the list. `last` (`Int`) Returns the last n elements from the list.
`timeout` (`Int!`)	The timeout in minutes for this protection rule.
`type` (`DeploymentProtectionRuleType!`)	The type of protection rule.

DeploymentProtectionRuleConnection

Object

The connection type for DeploymentProtectionRule.

Fields for `DeploymentProtectionRuleConnection`

Name	Description
`edges` (`[DeploymentProtectionRuleEdge]`)	A list of edges.
`nodes` (`[DeploymentProtectionRule]`)	A list of nodes.
`pageInfo` (`PageInfo!`)	Information to aid in pagination.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

DeploymentProtectionRuleEdge

Object

An edge in a connection.

Fields for `DeploymentProtectionRuleEdge`

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (`DeploymentProtectionRule`)	The item at the end of the edge.

DeploymentRequest

Object

A request to deploy a workflow run to an environment.

Fields for `DeploymentRequest`

Name	Description
`currentUserCanApprove` (`Boolean!`)	Whether or not the current user can approve the deployment.
`environment` (`Environment!`)	The target environment of the deployment.
`reviewers` (`DeploymentReviewerConnection!`)	The teams or users that can review the deployment. Arguments for `reviewers` `after` (`String`) Returns the elements in the list that come after the specified cursor. `before` (`String`) Returns the elements in the list that come before the specified cursor. `first` (`Int`) Returns the first n elements from the list. `last` (`Int`) Returns the last n elements from the list.
`waitTimer` (`Int!`)	The wait timer in minutes configured in the environment.
`waitTimerStartedAt` (`DateTime`)	The wait timer in minutes configured in the environment.

DeploymentRequestConnection

Object

The connection type for DeploymentRequest.

Fields for `DeploymentRequestConnection`

Name	Description
`edges` (`[DeploymentRequestEdge]`)	A list of edges.
`nodes` (`[DeploymentRequest]`)	A list of nodes.
`pageInfo` (`PageInfo!`)	Information to aid in pagination.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

DeploymentRequestEdge

Object

An edge in a connection.

Fields for `DeploymentRequestEdge`

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (`DeploymentRequest`)	The item at the end of the edge.

DeploymentReview

Object

A deployment review.

`DeploymentReview` Implements

Node

Fields for `DeploymentReview`

Name	Description
`comment` (`String!`)	The comment the user left.
`databaseId` (`Int`)	Identifies the primary key from the database.
`environments` (`EnvironmentConnection!`)	The environments approved or rejected. Arguments for `environments` `after` (`String`) Returns the elements in the list that come after the specified cursor. `before` (`String`) Returns the elements in the list that come before the specified cursor. `first` (`Int`) Returns the first n elements from the list. `last` (`Int`) Returns the last n elements from the list.
`id` (`ID!`)	The Node ID of the DeploymentReview object.
`state` (`DeploymentReviewState!`)	The decision of the user.
`user` (`User!`)	The user that reviewed the deployment.

DeploymentReviewConnection

Object

The connection type for DeploymentReview.

Fields for `DeploymentReviewConnection`

Name	Description
`edges` (`[DeploymentReviewEdge]`)	A list of edges.
`nodes` (`[DeploymentReview]`)	A list of nodes.
`pageInfo` (`PageInfo!`)	Information to aid in pagination.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

DeploymentReviewEdge

Object

An edge in a connection.

Fields for `DeploymentReviewEdge`

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (`DeploymentReview`)	The item at the end of the edge.

DeploymentReviewerConnection

Object

The connection type for DeploymentReviewer.

Fields for `DeploymentReviewerConnection`

Name	Description
`edges` (`[DeploymentReviewerEdge]`)	A list of edges.
`nodes` (`[DeploymentReviewer]`)	A list of nodes.
`pageInfo` (`PageInfo!`)	Information to aid in pagination.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

DeploymentReviewerEdge

Object

An edge in a connection.

Fields for `DeploymentReviewerEdge`

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (`DeploymentReviewer`)	The item at the end of the edge.

DeploymentStatus

Object

Describes the status of a given deployment attempt.

`DeploymentStatus` Implements

Node

Fields for `DeploymentStatus`

Name	Description
`createdAt` (`DateTime!`)	Identifies the date and time when the object was created.
`creator` (`Actor!`)	Identifies the actor who triggered the deployment.
`deployment` (`Deployment!`)	Identifies the deployment associated with status.
`description` (`String`)	Identifies the description of the deployment.
`environment` (`String`)	Identifies the environment of the deployment at the time of this deployment status.
`environmentUrl` (`URI`)	Identifies the environment URL of the deployment.
`id` (`ID!`)	The Node ID of the DeploymentStatus object.
`logUrl` (`URI`)	Identifies the log URL of the deployment.
`state` (`DeploymentStatusState!`)	Identifies the current state of the deployment.
`updatedAt` (`DateTime!`)	Identifies the date and time when the object was last updated.

DeploymentStatusConnection

Object

The connection type for DeploymentStatus.

Fields for `DeploymentStatusConnection`

Name	Description
`edges` (`[DeploymentStatusEdge]`)	A list of edges.
`nodes` (`[DeploymentStatus]`)	A list of nodes.
`pageInfo` (`PageInfo!`)	Information to aid in pagination.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

DeploymentStatusEdge

Object

An edge in a connection.

Fields for `DeploymentStatusEdge`

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (`DeploymentStatus`)	The item at the end of the edge.

Environment

Object

An environment.

`Environment` Implements

Node

Fields for `Environment`

Name	Description
`databaseId` (`Int`)	Identifies the primary key from the database.
`id` (`ID!`)	The Node ID of the Environment object.
`isPinned` (`Boolean`)	Indicates whether or not this environment is currently pinned to the repository.
`latestCompletedDeployment` (`Deployment`)	The latest completed deployment with status success, failure, or error if it exists.
`name` (`String!`)	The name of the environment.
`pinnedPosition` (`Int`)	The position of the environment if it is pinned, null if it is not pinned.
`protectionRules` (`DeploymentProtectionRuleConnection!`)	The protection rules defined for this environment. Arguments for `protectionRules` `after` (`String`) Returns the elements in the list that come after the specified cursor. `before` (`String`) Returns the elements in the list that come before the specified cursor. `first` (`Int`) Returns the first n elements from the list. `last` (`Int`) Returns the last n elements from the list.

EnvironmentConnection

Object

The connection type for Environment.

Fields for `EnvironmentConnection`

Name	Description
`edges` (`[EnvironmentEdge]`)	A list of edges.
`nodes` (`[Environment]`)	A list of nodes.
`pageInfo` (`PageInfo!`)	Information to aid in pagination.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

EnvironmentEdge

Object

An edge in a connection.

Fields for `EnvironmentEdge`

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (`Environment`)	The item at the end of the edge.

PinnedEnvironment

Object

Represents a pinned environment on a given repository.

`PinnedEnvironment` Implements

Node

Fields for `PinnedEnvironment`

Name	Description
`createdAt` (`DateTime!`)	Identifies the date and time when the pinned environment was created.
`databaseId` (`Int`)	Identifies the primary key from the database.
`environment` (`Environment!`)	Identifies the environment associated.
`id` (`ID!`)	The Node ID of the PinnedEnvironment object.
`position` (`Int!`)	Identifies the position of the pinned environment.
`repository` (`Repository!`)	The repository that this environment was pinned to.

PinnedEnvironmentConnection

Object

The connection type for PinnedEnvironment.

Fields for `PinnedEnvironmentConnection`

Name	Description
`edges` (`[PinnedEnvironmentEdge]`)	A list of edges.
`nodes` (`[PinnedEnvironment]`)	A list of nodes.
`pageInfo` (`PageInfo!`)	Information to aid in pagination.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

PinnedEnvironmentEdge

Object

An edge in a connection.

Fields for `PinnedEnvironmentEdge`

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (`PinnedEnvironment`)	The item at the end of the edge.

RequiredDeploymentsParameters

Object

Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.

Fields for `RequiredDeploymentsParameters`

Name	Description
`requiredDeploymentEnvironments` (`[String!]!`)	The environments that must be successfully deployed to before branches can be merged.

Enums

DeploymentOrderField

Enum

Properties by which deployment connections can be ordered.

Values for `DeploymentOrderField`

Name	Description
`CREATED_AT`	Order collection by creation time.

DeploymentProtectionRuleType

Enum

The possible protection rule types.

Values for `DeploymentProtectionRuleType`

Name	Description
`BRANCH_POLICY`	Branch policy.
`REQUIRED_REVIEWERS`	Required reviewers.
`WAIT_TIMER`	Wait timer.

DeploymentReviewState

Enum

The possible states for a deployment review.

Values for `DeploymentReviewState`

Name	Description
`APPROVED`	The deployment was approved.
`REJECTED`	The deployment was rejected.

DeploymentState

Enum

The possible states in which a deployment can be.

Values for `DeploymentState`

Name	Description
`ABANDONED`	The pending deployment was not updated after 30 minutes.
`ACTIVE`	The deployment is currently active.
`DESTROYED`	An inactive transient deployment.
`ERROR`	The deployment experienced an error.
`FAILURE`	The deployment has failed.
`INACTIVE`	The deployment is inactive.
`IN_PROGRESS`	The deployment is in progress.
`PENDING`	The deployment is pending.
`QUEUED`	The deployment has queued.
`SUCCESS`	The deployment was successful.
`WAITING`	The deployment is waiting.

DeploymentStatusState

Enum

The possible states for a deployment status.

Values for `DeploymentStatusState`

Name	Description
`ERROR`	The deployment experienced an error.
`FAILURE`	The deployment has failed.
`INACTIVE`	The deployment is inactive.
`IN_PROGRESS`	The deployment is in progress.
`PENDING`	The deployment is pending.
`QUEUED`	The deployment is queued.
`SUCCESS`	The deployment was successful.
`WAITING`	The deployment is waiting.

EnvironmentOrderField

Enum

Properties by which environments connections can be ordered.

Values for `EnvironmentOrderField`

Name	Description
`NAME`	Order environments by name.

EnvironmentPinnedFilterField

Enum

Properties by which environments connections can be ordered.

Values for `EnvironmentPinnedFilterField`

Name	Description
`ALL`	All environments will be returned.
`NONE`	Environments exclude pinned will be returned.
`ONLY`	Only pinned environment will be returned.

PinnedEnvironmentOrderField

Enum

Properties by which pinned environments connections can be ordered.

Values for `PinnedEnvironmentOrderField`

Name	Description
`POSITION`	Order pinned environments by position.

Unions

DeploymentReviewer

Union

Users and teams.

Possible types for `DeploymentReviewer`

Input objects

ApproveDeploymentsInput

Input object

Autogenerated input type of ApproveDeployments.

Input fields for `ApproveDeploymentsInput`

Name	Description
`clientMutationId` (

In this article

Input fields for approveDeployments

Return fields for approveDeployments

Input fields for createDeployment

Return fields for createDeployment

Input fields for createDeploymentStatus

Return fields for createDeploymentStatus

Input fields for createEnvironment

Return fields for createEnvironment

Input fields for deleteDeployment

Return fields for deleteDeployment

Input fields for deleteEnvironment

Return fields for deleteEnvironment

Input fields for pinEnvironment

Return fields for pinEnvironment

Input fields for rejectDeployments

Return fields for rejectDeployments

Input fields for reorderEnvironment

Return fields for reorderEnvironment

Input fields for updateEnvironment

Return fields for updateEnvironment

DeployedEvent Implements

Fields for DeployedEvent

Deployment Implements

Fields for Deployment

Fields for DeploymentConnection

Fields for DeploymentEdge

DeploymentEnvironmentChangedEvent Implements

Fields for DeploymentEnvironmentChangedEvent

Fields for DeploymentProtectionRule

Fields for DeploymentProtectionRuleConnection

Fields for DeploymentProtectionRuleEdge

Fields for DeploymentRequest

Fields for DeploymentRequestConnection

Fields for DeploymentRequestEdge

DeploymentReview Implements

Fields for DeploymentReview

Fields for DeploymentReviewConnection

Fields for DeploymentReviewEdge

Fields for DeploymentReviewerConnection

Fields for DeploymentReviewerEdge

DeploymentStatus Implements

Fields for DeploymentStatus

Fields for DeploymentStatusConnection

Fields for DeploymentStatusEdge

Environment Implements

Fields for Environment

Fields for EnvironmentConnection

Fields for EnvironmentEdge

PinnedEnvironment Implements

Fields for PinnedEnvironment

Fields for PinnedEnvironmentConnection

Fields for PinnedEnvironmentEdge

Fields for RequiredDeploymentsParameters

Values for DeploymentOrderField

Values for DeploymentProtectionRuleType

Values for DeploymentReviewState

Values for DeploymentState

Values for DeploymentStatusState

Values for EnvironmentOrderField

Values for EnvironmentPinnedFilterField

Values for PinnedEnvironmentOrderField

Possible types for DeploymentReviewer

Input fields for ApproveDeploymentsInput

Input fields for `approveDeployments`

Return fields for `approveDeployments`

Input fields for `createDeployment`

Return fields for `createDeployment`

Input fields for `createDeploymentStatus`

Return fields for `createDeploymentStatus`

Input fields for `createEnvironment`

Return fields for `createEnvironment`

Input fields for `deleteDeployment`

Return fields for `deleteDeployment`

Input fields for `deleteEnvironment`

Return fields for `deleteEnvironment`

Input fields for `pinEnvironment`

Return fields for `pinEnvironment`

Input fields for `rejectDeployments`

Return fields for `rejectDeployments`

Input fields for `reorderEnvironment`

Return fields for `reorderEnvironment`

Input fields for `updateEnvironment`

Return fields for `updateEnvironment`

`DeployedEvent` Implements

Fields for `DeployedEvent`

`Deployment` Implements

Fields for `Deployment`

Fields for `DeploymentConnection`

Fields for `DeploymentEdge`

`DeploymentEnvironmentChangedEvent` Implements

Fields for `DeploymentEnvironmentChangedEvent`

Fields for `DeploymentProtectionRule`

Fields for `DeploymentProtectionRuleConnection`

Fields for `DeploymentProtectionRuleEdge`

Fields for `DeploymentRequest`

Fields for `DeploymentRequestConnection`

Fields for `DeploymentRequestEdge`

`DeploymentReview` Implements

Fields for `DeploymentReview`

Fields for `DeploymentReviewConnection`

Fields for `DeploymentReviewEdge`

Fields for `DeploymentReviewerConnection`

Fields for `DeploymentReviewerEdge`

`DeploymentStatus` Implements

Fields for `DeploymentStatus`

Fields for `DeploymentStatusConnection`

Fields for `DeploymentStatusEdge`

`Environment` Implements

Fields for `Environment`

Fields for `EnvironmentConnection`

Fields for `EnvironmentEdge`

`PinnedEnvironment` Implements

Fields for `PinnedEnvironment`

Fields for `PinnedEnvironmentConnection`

Fields for `PinnedEnvironmentEdge`

Fields for `RequiredDeploymentsParameters`

Values for `DeploymentOrderField`

Values for `DeploymentProtectionRuleType`

Values for `DeploymentReviewState`

Values for `DeploymentState`

Values for `DeploymentStatusState`

Values for `EnvironmentOrderField`

Values for `EnvironmentPinnedFilterField`

Values for `PinnedEnvironmentOrderField`

Possible types for `DeploymentReviewer`

Input fields for `ApproveDeploymentsInput`