Sign in

v1

latestOpenAPI 3.1.02026-07-26289714404.6 KB
Environments

Get Environment

get/environments/{id}

Path parameters

idstring required

Query parameters

exclude_fieldsstring
fieldsstring

Response

idstring
createdAtstring date-time
updatedAtstring date-time
namestring required
organizationIdstring required
projectIdstring required
userIdstring required
workspaceNamestring required
requiresApprovalboolean required
status'CREATED' | 'INACTIVE' | 'ACTIVE' | 'FAILED' | 'TIMEOUT' | 'WAITING_FOR_USER' | 'DEPLOY_IN_PROGRESS' | 'DESTROY_IN_PROGRESS' | 'TASK_IN_PROGRESS' | 'ABORTING' | 'ABORTED' | 'NEVER_DEPLOYED' | 'DRIFTED' | 'DRY_RUN_IN_PROGRESS' | 'CREATED' | 'INACTIVE' | 'ACTIVE' | 'FAILED' | 'TIMEOUT' | 'WAITING_FOR_USER' | 'DEPLOY_IN_PROGRESS' | 'DESTROY_IN_PROGRESS' | 'TASK_IN_PROGRESS' | 'ABORTING' | 'ABORTED' | 'NEVER_DEPLOYED' | 'DRIFTED' | 'DRY_RUN_IN_PROGRESS' | 'CREATED' | 'INACTIVE' | 'ACTIVE' | 'FAILED' | 'TIMEOUT' | 'WAITING_FOR_USER' | 'DEPLOY_IN_PROGRESS' | 'DESTROY_IN_PROGRESS' | 'TASK_IN_PROGRESS' | 'ABORTING' | 'ABORTED' | 'NEVER_DEPLOYED' | 'DRIFTED' | 'DRY_RUN_IN_PROGRESS' required
latestDeploymentLogIdstring required
lifespanEndAtstring date-time required
markedForAutoDestroy0 | 1 | 2 | 3 | 0 | 1 | 2 | 3 required
isArchivedboolean required

Mark the environment as inactive

vcsCommandsAliasstring
vcsPrCommentsEnabledboolean
continuousDeploymentboolean required
pullRequestPlanDeploymentsboolean required
autoDeployOnPathChangesOnlyboolean required
autoDeployByCustomGlobstring
terragruntWorkingDirectorystring
isSingleUseBlueprintboolean
workflowEnvironmentIdstring
isRemoteBackendboolean required
isLockedboolean required
k8sNamespacestring
isRemoteApplyEnabledboolean
driftStatus'ERROR' | 'DRIFTED' | 'OK' | 'NEVER_RUN' | 'DISABLED' | 'ERROR' | 'DRIFTED' | 'OK' | 'NEVER_RUN' | 'DISABLED' | 'ERROR' | 'DRIFTED' | 'OK' | 'NEVER_RUN' | 'DISABLED' required