Sign in

v1

latestOpenAPI 3.1.02026-07-26289714404.6 KB
Environments

Deploy Environment

post/environments/{id}/deployments

Path parameters

idstring required

Request body

workflowDeploymentIdstring
deploymentType'deploy' | 'prPlan' | 'driftDetection' | 'task' | 'remotePlan' | 'dryRun' | 'moduleTest'
blueprintIdstring
blueprintRevisionstring
blueprintRepositorystring
envNamestring
userRequiresApprovalboolean
targetsstring[]
commentstring
upstreamEnvironmentIdstring
taskPayloadstring
subEnvironmentsobject
autoDriftRemediationStrategy'DISABLED' | 'CODE_TO_CLOUD' | 'CLOUD_TO_CODE' | 'SMART_REMEDIATION' | 'DISABLED' | 'CODE_TO_CLOUD' | 'CLOUD_TO_CODE' | 'SMART_REMEDIATION'
subEnvironmentAliasstring

Response

idstring required
createdAtstring date-time
updatedAtstring date-time
type'deploy' | 'destroy' | 'prPlan' | 'driftDetection' | 'task' | 'remotePlan' | 'dryRun' | 'moduleTest' | 'deploy' | 'destroy' | 'prPlan' | 'driftDetection' | 'task' | 'remotePlan' | 'dryRun' | 'moduleTest' required
startedBystring required
queuedAtstring date-time required
startedAtstring date-time required
finishedAtstring date-time required
errorobject required
failedCommandstring
stoppedByTimeoutReason'DEPLOYMENT_TIME_LIMIT_EXCEEDED' | 'AGENT_UNRESPONSIVE' | 'DEPLOYMENT_NOT_STARTED' | 'DEPLOYMENT_TIME_LIMIT_EXCEEDED' | 'AGENT_UNRESPONSIVE' | 'DEPLOYMENT_NOT_STARTED'
status'IN_PROGRESS' | 'WAITING_FOR_USER' | 'TIMEOUT' | 'FAILURE' | 'SUCCESS' | 'CANCELLED' | 'INTERNAL_FAILURE' | 'ABORTING' | 'ABORTED' | 'QUEUED' | 'SKIPPED' | 'NEVER_DEPLOYED' | 'IN_PROGRESS' | 'WAITING_FOR_USER' | 'TIMEOUT' | 'FAILURE' | 'SUCCESS' | 'CANCELLED' | 'INTERNAL_FAILURE' | 'ABORTING' | 'ABORTED' | 'QUEUED' | 'SKIPPED' | 'NEVER_DEPLOYED' | 'IN_PROGRESS' | 'WAITING_FOR_USER' | 'TIMEOUT' | 'FAILURE' | 'SUCCESS' | 'CANCELLED' | 'INTERNAL_FAILURE' | 'ABORTING' | 'ABORTED' | 'QUEUED' | 'SKIPPED' | 'NEVER_DEPLOYED' required
blueprintIdstring required
blueprintNamestring required
blueprintRepositorystring required
blueprintRevisionstring required
blueprintPathstring required
commentstring
environmentIdstring required
resourceCountnumber required
isScheduledRunboolean required
abortedBystring required
gitUserstring
gitAvatarUrlstring
prNumberstring
driftDetectedboolean
isSkippedApplyboolean
workflowDeploymentIdstring
stateVersionIdstring
reviewedBystring
targetsstring[]