Reference documentation for GraphQL schema types in the Deployments category.
Approve all pending deployments under one or more environments.
approveDeploymentsinput (ApproveDeploymentsInput!):approveDeploymentsclientMutationId (String): A unique identifier for the client performing the mutation.deployments ([Deployment!]): The affected deployments.Autogenerated input type of ApproveDeployments.
ApproveDeploymentsInputclientMutationId (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.Creates a new deployment event.
createDeploymentinput (CreateDeploymentInput!):createDeploymentautoMerged (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.Autogenerated input type of CreateDeployment.
CreateDeploymentInputautoMerge (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 requiredtask (String): Specifies a task to execute.Create a deployment status.
createDeploymentStatusinput (CreateDeploymentStatusInput!):createDeploymentStatusclientMutationId (String): A unique identifier for the client performing the mutation.deploymentStatus (DeploymentStatus): The new deployment status.Autogenerated input type of CreateDeploymentStatus.
CreateDeploymentStatusInputautoInactive (Boolean): Adds a new inactive status to all non-transient, non-production environmentclientMutationId (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 containstate (DeploymentStatusState!): The state of the deployment.Creates an environment or simply returns it if already exists.
createEnvironmentinput (CreateEnvironmentInput!):createEnvironmentclientMutationId (String): A unique identifier for the client performing the mutation.environment (Environment): The new or existing environment.Autogenerated input type of CreateEnvironment.
CreateEnvironmentInputclientMutationId (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.Deletes a deployment.
deleteDeploymentinput (DeleteDeploymentInput!):deleteDeploymentclientMutationId (String): A unique identifier for the client performing the mutation.Autogenerated input type of DeleteDeployment.
DeleteDeploymentInputclientMutationId (String): A unique identifier for the client performing the mutation.id (ID!): The Node ID of the deployment to be deleted.Deletes an environment.
deleteEnvironmentinput (DeleteEnvironmentInput!):deleteEnvironmentclientMutationId (String): A unique identifier for the client performing the mutation.Autogenerated input type of DeleteEnvironment.
DeleteEnvironmentInputclientMutationId (String): A unique identifier for the client performing the mutation.id (ID!): The Node ID of the environment to be deleted.Represents a deployed event on a given pull request.
Implements: Node
DeployedEventactor (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.Represents triggered deployment instance.
Implements: Node
Deploymentcommit (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. (Pagination: after, before, first, last)task (String): The deployment task.updatedAt (DateTime!): Identifies the date and time when the object was last updated.The connection type for Deployment.
DeploymentConnectionedges ([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.An edge in a connection.
DeploymentEdgecursor (String!): A cursor for use in pagination.node (Deployment): The item at the end of the edge.Represents a deployment_environment_changed event on a given pull request.
Implements: Node
DeploymentEnvironmentChangedEventactor (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.Ordering options for deployment connections.
DeploymentOrderdirection (OrderDirection!): The ordering direction.field (DeploymentOrderField!): The field to order deployments by.Properties by which deployment connections can be ordered.
DeploymentOrderFieldCREATED_AT: Order collection by creation time.A protection rule.
DeploymentProtectionRuledatabaseId (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. (Pagination: after, before, first, last)timeout (Int!): The timeout in minutes for this protection rule.type (DeploymentProtectionRuleType!): The type of protection rule.The connection type for DeploymentProtectionRule.
DeploymentProtectionRuleConnectionedges ([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.An edge in a connection.
DeploymentProtectionRuleEdgecursor (String!): A cursor for use in pagination.node (DeploymentProtectionRule): The item at the end of the edge.The possible protection rule types.
DeploymentProtectionRuleTypeBRANCH_POLICY: Branch policy.REQUIRED_REVIEWERS: Required reviewers.WAIT_TIMER: Wait timer.A request to deploy a workflow run to an environment.
DeploymentRequestcurrentUserCanApprove (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. (Pagination: after, before, first, last)waitTimer (Int!): The wait timer in minutes configured in the environment.waitTimerStartedAt (DateTime): The wait timer in minutes configured in the environment.The connection type for DeploymentRequest.
DeploymentRequestConnectionedges ([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.An edge in a connection.
DeploymentRequestEdgecursor (String!): A cursor for use in pagination.node (DeploymentRequest): The item at the end of the edge.A deployment review.
Implements: Node
DeploymentReviewcomment (String!): The comment the user left.databaseId (Int): Identifies the primary key from the database.environments (EnvironmentConnection!): The environments approved or rejected. (Pagination: after, before, first, last)id (ID!): The Node ID of the DeploymentReview object.state (DeploymentReviewState!): The decision of the user.user (User!): The user that reviewed the deployment.The connection type for DeploymentReview.
DeploymentReviewConnectionedges ([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.An edge in a connection.
DeploymentReviewEdgecursor (String!): A cursor for use in pagination.node (DeploymentReview): The item at the end of the edge.Users and teams.
DeploymentReviewerThe connection type for DeploymentReviewer.
DeploymentReviewerConnectionedges ([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.An edge in a connection.
DeploymentReviewerEdgecursor (String!): A cursor for use in pagination.node (DeploymentReviewer): The item at the end of the edge.The possible states for a deployment review.
DeploymentReviewStateAPPROVED: The deployment was approved.REJECTED: The deployment was rejected.The possible states in which a deployment can be.
DeploymentStateABANDONED: 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.Describes the status of a given deployment attempt.
Implements: Node
DeploymentStatuscreatedAt (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.The connection type for DeploymentStatus.
DeploymentStatusConnectionedges ([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.An edge in a connection.
DeploymentStatusEdgecursor (String!): A cursor for use in pagination.node (DeploymentStatus): The item at the end of the edge.The possible states for a deployment status.
DeploymentStatusStateERROR: 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.An environment.
Implements: Node
EnvironmentdatabaseId (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. (Pagination: after, before, first, last)The connection type for Environment.
EnvironmentConnectionedges ([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.An edge in a connection.
EnvironmentEdgecursor (String!): A cursor for use in pagination.node (Environment): The item at the end of the edge.Properties by which environments connections can be ordered.
EnvironmentOrderFieldNAME: Order environments by name.Properties by which environments connections can be ordered.
EnvironmentPinnedFilterFieldALL: All environments will be returned.NONE: Environments exclude pinned will be returned.ONLY: Only pinned environment will be returned.Ordering options for environments.
Environmentsdirection (OrderDirection!): The direction in which to order environments by the specified field.field (EnvironmentOrderField!): The field to order environments by.Pin an environment to a repository.
pinEnvironmentinput (PinEnvironmentInput!):pinEnvironmentclientMutationId (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.Autogenerated input type of PinEnvironment.
PinEnvironmentInputclientMutationId (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.Represents a pinned environment on a given repository.
Implements: Node
PinnedEnvironmentcreatedAt (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.The connection type for PinnedEnvironment.
PinnedEnvironmentConnectionedges ([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.An edge in a connection.
PinnedEnvironmentEdgecursor (String!): A cursor for use in pagination.node (PinnedEnvironment): The item at the end of the edge.Ordering options for pinned environments.
PinnedEnvironmentOrderdirection (OrderDirection!): The direction in which to order pinned environments by the specified field.field (PinnedEnvironmentOrderField!): The field to order pinned environments by.Properties by which pinned environments connections can be ordered.
PinnedEnvironmentOrderFieldPOSITION: Order pinned environments by position.Reject all pending deployments under one or more environments.
rejectDeploymentsinput (RejectDeploymentsInput!):rejectDeploymentsclientMutationId (String): A unique identifier for the client performing the mutation.deployments ([Deployment!]): The affected deployments.Autogenerated input type of RejectDeployments.
RejectDeploymentsInputclientMutationId (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.Reorder a pinned repository environment.
reorderEnvironmentinput (ReorderEnvironmentInput!):reorderEnvironmentclientMutationId (String): A unique identifier for the client performing the mutation.environment (Environment): The environment that was reordered.Autogenerated input type of ReorderEnvironment.
ReorderEnvironmentInputclientMutationId (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.Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
RequiredDeploymentsParametersrequiredDeploymentEnvironments ([String!]!): The environments that must be successfully deployed to before branches can be merged.Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.
RequiredDeploymentsParametersInputrequiredDeploymentEnvironments ([String!]!): The environments that must be successfully deployed to before branches can be merged.Updates an environment.
updateEnvironmentinput (UpdateEnvironmentInput!):updateEnvironmentclientMutationId (String): A unique identifier for the client performing the mutation.environment (Environment): The updated environment.Autogenerated input type of UpdateEnvironment.
UpdateEnvironmentInputclientMutationId (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.