Reference documentation for GraphQL schema types in the Deployments category.

Dans cet article

Mutations

approveDeployments

Mutation

Approve all pending deployments under one or more environments.

Champs d’entrée pour approveDeployments

Champs de retour pour approveDeployments

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

createDeployment

Mutation

Creates a new deployment event.

Champs d’entrée pour createDeployment

Champs de retour pour createDeployment

NomDescription

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.

Champs d’entrée pour createDeploymentStatus

Champs de retour pour createDeploymentStatus

NomDescription

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.

Champs d’entrée pour createEnvironment

Champs de retour pour createEnvironment

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The new or existing environment.

deleteDeployment

Mutation

Deletes a deployment.

Champs d’entrée pour deleteDeployment

Champs de retour pour deleteDeployment

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deleteEnvironment

Mutation

Deletes an environment.

Champs d’entrée pour deleteEnvironment

Champs de retour pour deleteEnvironment

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

pinEnvironment

Mutation

Pin an environment to a repository.

Champs d’entrée pour pinEnvironment

Champs de retour pour pinEnvironment

NomDescription

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.

Champs d’entrée pour rejectDeployments

Champs de retour pour rejectDeployments

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deployments ([Deployment!])

The affected deployments.

reorderEnvironment

Mutation

Reorder a pinned repository environment.

Champs d’entrée pour reorderEnvironment

Champs de retour pour reorderEnvironment

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environment (Environment)

The environment that was reordered.

updateEnvironment

Mutation

Updates an environment.

Champs d’entrée pour updateEnvironment

Champs de retour pour updateEnvironment

NomDescription

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 Met en œuvre

Champs pour DeployedEvent

NomDescription

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 thedeployedevent.

id (ID!)

The Node ID of the DeployedEvent object.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

The ref associated with thedeployedevent.

Deployment

Object

Represents triggered deployment instance.

Deployment Met en œuvre

Champs pour Deployment

NomDescription

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 pour 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.

Champs pour DeploymentConnection

NomDescription

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.

Champs pour DeploymentEdge

NomDescription

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 Met en œuvre

Champs pour DeploymentEnvironmentChangedEvent

NomDescription

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.

Champs pour DeploymentProtectionRule

NomDescription

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 pour 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.

Champs pour DeploymentProtectionRuleConnection

NomDescription

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.

Champs pour DeploymentProtectionRuleEdge

NomDescription

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.

Champs pour DeploymentRequest

NomDescription

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 pour 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.

Champs pour DeploymentRequestConnection

NomDescription

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.

Champs pour DeploymentRequestEdge

NomDescription

cursor (String!)

A cursor for use in pagination.

node (DeploymentRequest)

The item at the end of the edge.

DeploymentReview

Object

A deployment review.

DeploymentReview Met en œuvre

Champs pour DeploymentReview

NomDescription

comment (String!)

The comment the user left.

databaseId (Int)

Identifies the primary key from the database.

environments (EnvironmentConnection!)

The environments approved or rejected.

Arguments pour 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.

Champs pour DeploymentReviewConnection

NomDescription

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.

Champs pour DeploymentReviewEdge

NomDescription

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.

Champs pour DeploymentReviewerConnection

NomDescription

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.

Champs pour DeploymentReviewerEdge

NomDescription

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 Met en œuvre

Champs pour DeploymentStatus

NomDescription

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.

Champs pour DeploymentStatusConnection

NomDescription

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.

Champs pour DeploymentStatusEdge

NomDescription

cursor (String!)

A cursor for use in pagination.

node (DeploymentStatus)

The item at the end of the edge.

Environment

Object

An environment.

Environment Met en œuvre

Champs pour Environment

NomDescription

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 pour 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.

Champs pour EnvironmentConnection

NomDescription

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.

Champs pour EnvironmentEdge

NomDescription

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 Met en œuvre

Champs pour PinnedEnvironment

NomDescription

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.

Champs pour PinnedEnvironmentConnection

NomDescription

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.

Champs pour PinnedEnvironmentEdge

NomDescription

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.

Champs pour RequiredDeploymentsParameters

NomDescription

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.

Valeurs pour DeploymentOrderField.

NomDescription
CREATED_AT

Order collection by creation time.

DeploymentProtectionRuleType

Enum

The possible protection rule types.

Valeurs pour DeploymentProtectionRuleType.

NomDescription
BRANCH_POLICY

Branch policy.

REQUIRED_REVIEWERS

Required reviewers.

WAIT_TIMER

Wait timer.

DeploymentReviewState

Enum

The possible states for a deployment review.

Valeurs pour DeploymentReviewState.

NomDescription
APPROVED

The deployment was approved.

REJECTED

The deployment was rejected.

DeploymentState

Enum

The possible states in which a deployment can be.

Valeurs pour DeploymentState.

NomDescription
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.

Valeurs pour DeploymentStatusState.

NomDescription
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.

Valeurs pour EnvironmentOrderField.

NomDescription
NAME

Order environments by name.

EnvironmentPinnedFilterField

Enum

Properties by which environments connections can be ordered.

Valeurs pour EnvironmentPinnedFilterField.

NomDescription
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.

Valeurs pour PinnedEnvironmentOrderField.

NomDescription
POSITION

Order pinned environments by position.

Unions

DeploymentReviewer

Union

Users and teams.

Types possibles pour DeploymentReviewer

Input objects

ApproveDeploymentsInput

Input object

Autogenerated input type of ApproveDeployments.

Champs d’entrée pour ApproveDeploymentsInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (String)

Optional comment for approving deployments.

environmentIds ([ID!]!)

The ids of environments to reject deployments.

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

CreateDeploymentInput

Input object

Autogenerated input type of CreateDeployment.

Champs d’entrée pour CreateDeploymentInput

NomDescription

autoMerge (Boolean)

Attempt to automatically merge the default branch into the requested ref, defaults to true.

clientMutationId (String)

A unique identifier for the client performing the mutation.

description (String)

Short description of the deployment.

environment (String)

Name for the target deployment environment.

payload (String)

JSON payload with extra information about the deployment.

refId (ID!)

The node ID of the ref to be deployed.

repositoryId (ID!)

The node ID of the repository.

requiredContexts ([String!])

The status contexts to verify against commit status checks. To bypass required contexts, pass an empty array. Defaults to all unique contexts.

task (String)

Specifies a task to execute.

CreateDeploymentStatusInput

Input object

Autogenerated input type of CreateDeploymentStatus.

Champs d’entrée pour CreateDeploymentStatusInput

NomDescription

autoInactive (Boolean)

Adds a new inactive status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment.

clientMutationId (String)

A unique identifier for the client performing the mutation.

deploymentId (ID!)

The node ID of the deployment.

description (String)

A short description of the status. Maximum length of 140 characters.

environment (String)

If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

environmentUrl (String)

Sets the URL for accessing your environment.

logUrl (String)

The log URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.

state (DeploymentStatusState!)

The state of the deployment.

CreateEnvironmentInput

Input object

Autogenerated input type of CreateEnvironment.

Champs d’entrée pour CreateEnvironmentInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of the environment.

repositoryId (ID!)

The node ID of the repository.

DeleteDeploymentInput

Input object

Autogenerated input type of DeleteDeployment.

Champs d’entrée pour DeleteDeploymentInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the deployment to be deleted.

DeleteEnvironmentInput

Input object

Autogenerated input type of DeleteEnvironment.

Champs d’entrée pour DeleteEnvironmentInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

id (ID!)

The Node ID of the environment to be deleted.

DeploymentOrder

Input object

Ordering options for deployment connections.

Champs d’entrée pour DeploymentOrder

NomDescription

direction (OrderDirection!)

The ordering direction.

field (DeploymentOrderField!)

The field to order deployments by.

Environments

Input object

Ordering options for environments.

Champs d’entrée pour Environments

NomDescription

direction (OrderDirection!)

The direction in which to order environments by the specified field.

field (EnvironmentOrderField!)

The field to order environments by.

PinEnvironmentInput

Input object

Autogenerated input type of PinEnvironment.

Champs d’entrée pour PinEnvironmentInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environmentId (ID!)

The ID of the environment to modify.

pinned (Boolean!)

The desired state of the environment. If true, environment will be pinned. If false, it will be unpinned.

PinnedEnvironmentOrder

Input object

Ordering options for pinned environments.

Champs d’entrée pour PinnedEnvironmentOrder

NomDescription

direction (OrderDirection!)

The direction in which to order pinned environments by the specified field.

field (PinnedEnvironmentOrderField!)

The field to order pinned environments by.

RejectDeploymentsInput

Input object

Autogenerated input type of RejectDeployments.

Champs d’entrée pour RejectDeploymentsInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (String)

Optional comment for rejecting deployments.

environmentIds ([ID!]!)

The ids of environments to reject deployments.

workflowRunId (ID!)

The node ID of the workflow run containing the pending deployments.

ReorderEnvironmentInput

Input object

Autogenerated input type of ReorderEnvironment.

Champs d’entrée pour ReorderEnvironmentInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environmentId (ID!)

The ID of the environment to modify.

position (Int!)

The desired position of the environment.

RequiredDeploymentsParametersInput

Input object

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

Champs d’entrée pour RequiredDeploymentsParametersInput

NomDescription

requiredDeploymentEnvironments ([String!]!)

The environments that must be successfully deployed to before branches can be merged.

UpdateEnvironmentInput

Input object

Autogenerated input type of UpdateEnvironment.

Champs d’entrée pour UpdateEnvironmentInput

NomDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

environmentId (ID!)

The node ID of the environment.

preventSelfReview (Boolean)

Whether deployments to this environment can be approved by the user who created the deployment.

reviewers ([ID!])

The ids of users or teams that can approve deployments to this environment.

waitTimer (Int)

The wait timer in minutes.