Destroy resumed webhook

Authorizations

Authorization

string

header

required

env0 API authentication is done via API keys. An API Key can either be created by an organization administrator, in which case it will not be connected to any specific user, or via Personal API Keys to authenticate as a user.

Creating an API Key with a Specific Role

Once you've created your organization, you can set up and manage API Keys.
Navigate to the Organization Settings page and click the API Keys tab.
Click Add API Key and enter a name for your key in the Name field. This name is for reference purposes only and isn't used directly in authentication.

❗️Save Your API Key ID and secret The secret will not be available after you close this window.

Creating a Personal API Key

Click on your avatar (located on the top right of the screen)
Click on Personal Settings
Select the API Keys tab
Click Add API Key, and enter a name for your key in the Name field. This name is for reference purposes and isn't used directly in authentication.

❗️Save your API Key ID & secret The secret will not be available after you close this window.

Using an API Key to Authenticate

Authentication of the env0 API is done using the Basic Authentication method. Each request made should include the API Key ID as the username, and the API Key secret as the password. For example, when using curl, we can include these parameters via flag --user {API Key ID}:{API Key Secret}.

API Key Permissions

When creating an API key through the organization settings, you will need to choose if you’d like to grant it Organization Admin or User permissions. In case of the latter, you can assign fine-grained permissions per project. Personal API Keys can be created through the user’s profile page and will have the same permissions as the user has.

Rate Limits

env0 API allows up to 1K requests per 60 seconds, requests are aggregated by IP, HTTP Method and URI. If you exceed this limit, you will receive a 429 status code.

Body

application/json

This is the schema of what env0 sends to your endpoint when a destroy has been resumed after an approval

type

string

required

Allowed value: "com.env0.destroy.resumed"

source

string

required

Allowed value: "https://env0.com"

string

required

time

string

required

datacontenttype

string

required

Allowed value: "application/json"

data

object

required

Show child attributes

data.deploymentLog

object

required

Show child attributes

data.deploymentLog.url

string

required

data.deploymentLog.type

enum<string>

required

Available options:

deploy,

destroy,

prPlan,

driftDetection,

task,

remotePlan,

dryRun,

moduleTest,

deploy,

destroy,

prPlan,

driftDetection,

task,

remotePlan,

dryRun,

moduleTest

data.deploymentLog.startedBy

string

required

data.deploymentLog.queuedAt

string<date-time>

required

data.deploymentLog.startedAt

string<date-time>

required

data.deploymentLog.finishedAt

string<date-time>

required

data.deploymentLog.output

object

required

Option 1 · object
Option 2 · object[]
Option 3 · object
Option 4 · object[]

Show child attributes

data.deploymentLog.output.{key}

object

Show child attributes

data.deploymentLog.output.{key}.value

any

required

data.deploymentLog.output.{key}.sensitive

boolean

required

data.deploymentLog.output.{key}.type

string

required

data.deploymentLog.error

object

required

data.deploymentLog.costEstimation

object

required

Show child attributes

data.deploymentLog.costEstimation.totalMonthlyCost

number

required

data.deploymentLog.costEstimation.monthlyCostDiff

number

required

data.deploymentLog.costEstimation.projects

object[]

required

Show child attributes

data.deploymentLog.costEstimation.projects.diff

object

required

Show child attributes

data.deploymentLog.costEstimation.projects.diff.totalMonthlyCost

string

required

data.deploymentLog.status

enum<string>

required

Available options:

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

data.deploymentLog.blueprintId

string

required

data.deploymentLog.blueprintName

string

required

data.deploymentLog.blueprintRepository

string

required

data.deploymentLog.blueprintRevision

string

required

data.deploymentLog.blueprintPath

string

required

data.deploymentLog.blueprintType

enum<string>

required

Available options:

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

workflow,

module,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

workflow,

module

data.deploymentLog.environmentId

string

required

data.deploymentLog.resourceCount

number

required

data.deploymentLog.startedByUser

object

required

Show child attributes

data.deploymentLog.startedByUser.email

string

data.deploymentLog.startedByUser.user_id

string

data.deploymentLog.startedByUser.created_at

string

data.deploymentLog.startedByUser.app_metadata

object

data.deploymentLog.startedByUser.picture

string

data.deploymentLog.startedByUser.name

string

data.deploymentLog.startedByUser.given_name

string

data.deploymentLog.startedByUser.family_name

string

data.deploymentLog.isScheduledRun

boolean

required

data.deploymentLog.abortedBy

string

required

data.deploymentLog.abortedByUser

object

required

Show child attributes

data.deploymentLog.abortedByUser.email

string

data.deploymentLog.abortedByUser.user_id

string

data.deploymentLog.abortedByUser.created_at

string

data.deploymentLog.abortedByUser.app_metadata

object

data.deploymentLog.abortedByUser.picture

string

data.deploymentLog.abortedByUser.name

string

data.deploymentLog.abortedByUser.given_name

string

data.deploymentLog.abortedByUser.family_name

string

data.deploymentLog.reviewersUsers

object[]

required

Show child attributes

data.deploymentLog.reviewersUsers.user

object

required

Show child attributes

data.deploymentLog.reviewersUsers.user.email

string

data.deploymentLog.reviewersUsers.user.user_id

string

data.deploymentLog.reviewersUsers.user.created_at

string

data.deploymentLog.reviewersUsers.user.app_metadata

object

data.deploymentLog.reviewersUsers.user.picture

string

data.deploymentLog.reviewersUsers.user.name

string

data.deploymentLog.reviewersUsers.user.given_name

string

data.deploymentLog.reviewersUsers.user.family_name

string

data.deploymentLog.reviewersUsers.action

enum<string>

required

Available options:

approved,

cancelled,

approved,

cancelled

data.deploymentLog.reviewers

object[]

required

Show child attributes

data.deploymentLog.reviewers.userId

string

required

data.deploymentLog.reviewers.action

enum<string>

required

Available options:

approved,

cancelled,

approved,

cancelled

data.deploymentLog.id

string

data.deploymentLog.createdAt

string<date-time>

data.deploymentLog.updatedAt

string<date-time>

data.deploymentLog.failedCommand

string

data.deploymentLog.customEnv0EnvironmentVariables

object

Show child attributes

data.deploymentLog.customEnv0EnvironmentVariables.environmentId

string

The deployed Environment ID

data.deploymentLog.customEnv0EnvironmentVariables.projectId

string

ENV0_PROJECT_ID

data.deploymentLog.customEnv0EnvironmentVariables.projectName

string

The Project Name of the deployed Environment

data.deploymentLog.customEnv0EnvironmentVariables.deploymentLogId

string

The deployment ID

data.deploymentLog.customEnv0EnvironmentVariables.deploymentType

enum<string>

The deployment type.

Available options:

deploy,

destroy,

prPlan,

deploy,

destroy,

prPlan,

deploy,

destroy,

prPlan

data.deploymentLog.customEnv0EnvironmentVariables.deploymentRevision

string

Available only when deployment revision defined

data.deploymentLog.customEnv0EnvironmentVariables.workspaceName

string

The Terraform Workspace name used in the Environment

data.deploymentLog.customEnv0EnvironmentVariables.rootDir

string

The root repository path

data.deploymentLog.customEnv0EnvironmentVariables.organizationId

string

data.deploymentLog.customEnv0EnvironmentVariables.templateId

string

data.deploymentLog.customEnv0EnvironmentVariables.templateDir

string

data.deploymentLog.customEnv0EnvironmentVariables.templateName

string

data.deploymentLog.customEnv0EnvironmentVariables.environmentName

string

data.deploymentLog.customEnv0EnvironmentVariables.environmentCreatorName

string

data.deploymentLog.customEnv0EnvironmentVariables.environmentCreatorUserId

string

data.deploymentLog.customEnv0EnvironmentVariables.environmentCreatorEmail

string

data.deploymentLog.customEnv0EnvironmentVariables.deployerName

string

data.deploymentLog.customEnv0EnvironmentVariables.deployerUserId

string

data.deploymentLog.customEnv0EnvironmentVariables.deployerEmail

string

data.deploymentLog.customEnv0EnvironmentVariables.reviewerName

string

data.deploymentLog.customEnv0EnvironmentVariables.reviewerEmail

string

data.deploymentLog.customEnv0EnvironmentVariables.reviewerUserId

string

data.deploymentLog.customEnv0EnvironmentVariables.vcsProvider

enum<string>

the vcs provider

Available options:

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps

data.deploymentLog.customEnv0EnvironmentVariables.prAuthor

string

pr author. available only in PR Plan

data.deploymentLog.customEnv0EnvironmentVariables.prNumber

string

the pr number. available only in PR Plan

data.deploymentLog.customEnv0EnvironmentVariables.prSourceRepository

string

the source repository. available only in PR Plan for the VCSs supporting fork PR Plans)"

data.deploymentLog.customEnv0EnvironmentVariables.prSourceBranch

string

the source branch. available only in PR Plan

data.deploymentLog.customEnv0EnvironmentVariables.prTargetBranch

string

the target branch. available only in PR Plan

data.deploymentLog.customEnv0EnvironmentVariables.commitHash

string

the commit hash

data.deploymentLog.customEnv0EnvironmentVariables.commitUrl

string

the commit url

data.deploymentLog.customEnv0EnvironmentVariables.oidcToken

string

The OIDC Token - read more here(https://docs.env0.com/docs/oidc-integrations) on how to enable it and use it

data.deploymentLog.customEnv0EnvironmentVariables.vcsAccessToken

string

When using a native VCS integration, this will represent the access token we use to clone the repository

data.deploymentLog.customEnv0EnvironmentVariables.tfPlanJson

string

The file path to a JSON representation of a Terraform Plan file

data.deploymentLog.customEnv0EnvironmentVariables.cliArgsPlan

string

add additional cli arguments when running a plan

data.deploymentLog.customEnv0EnvironmentVariables.cliArgsApply

string

add additional cli arguments when running the apply command

data.deploymentLog.customEnv0EnvironmentVariables.discoveryRepositoryUrl

string

Repository URL to write PR comments to. Used for prPlan deployments to override the target repo for comments.

data.deploymentLog.customEnv0EnvironmentVariables.discoveryPrNumber

string

PR number to write comments to. Used for prPlan deployments to override the target PR.

data.deploymentLog.customEnv0EnvironmentVariables.discoveryVCS

enum<string>

Discovery VCS provider (e.g., 'github')

Available options:

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps

data.deploymentLog.comment

string

data.deploymentLog.resources

object[]

Show child attributes

data.deploymentLog.resources.provider

string

required

data.deploymentLog.resources.type

string

required

data.deploymentLog.resources.name

string

required

data.deploymentLog.resources.moduleName

string

data.deploymentLog.gitUser

string

data.deploymentLog.gitAvatarUrl

string

data.deploymentLog.prNumber

string

data.deploymentLog.triggerName

Available options:

user,

terraform-cli,

workflow,

user,

terraform-cli,

workflow,

user,

terraform-cli,

workflow

data.deploymentLog.driftDetected

boolean

data.deploymentLog.plan

object

Show child attributes

data.deploymentLog.plan.resourceChanges

object[]

required

Show child attributes

data.deploymentLog.plan.resourceChanges.name

string

required

data.deploymentLog.plan.resourceChanges.providerName

string

required

data.deploymentLog.plan.resourceChanges.type

string

required

data.deploymentLog.plan.resourceChanges.path

string

required

data.deploymentLog.plan.resourceChanges.action

enum<string>

required

Available options:

create,

update,

delete,

recreate,

metadata,

create,

update,

delete,

recreate,

metadata

data.deploymentLog.plan.resourceChanges.attributes

object[]

required

Show child attributes

data.deploymentLog.plan.resourceChanges.attributes.name

string

required

data.deploymentLog.plan.resourceChanges.attributes.before

any

data.deploymentLog.plan.resourceChanges.attributes.after

any

data.deploymentLog.plan.resourceChanges.id

string

data.deploymentLog.plan.resourceChanges.cloudId

string

data.deploymentLog.plan.resourceChanges.moduleName

string

data.deploymentLog.plan.resourceChanges.driftByCloud

boolean

data.deploymentLog.plan.resourceChanges.importing

object

Show child attributes

data.deploymentLog.plan.resourceChanges.importing.id

string

required

data.deploymentLog.plan.resourceChanges.actionReason

enum<string>

Available options:

replace_because_tainted,

replace_because_cannot_update,

replace_by_request,

delete_because_no_resource_config,

delete_because_no_module,

delete_because_wrong_repetition,

delete_because_count_index,

delete_because_each_key,

read_because_config_unknown,

read_because_dependency_pending,

replace_because_tainted,

replace_because_cannot_update,

replace_by_request,

delete_because_no_resource_config,

delete_because_no_module,

delete_because_wrong_repetition,

delete_because_count_index,

delete_because_each_key,

read_because_config_unknown,

read_because_dependency_pending

data.deploymentLog.plan.resourceChanges.createBeforeDestroy

boolean

data.deploymentLog.plan.resourceChanges.previousAddress

string

data.deploymentLog.plan.outputChanges

object[]

required

Show child attributes

data.deploymentLog.plan.outputChanges.name

string

required

data.deploymentLog.plan.outputChanges.action

enum<string>

required

Available options:

create,

update,

delete,

recreate,

metadata,

create,

update,

delete,

recreate,

metadata

data.deploymentLog.plan.outputChanges.attributes

object[]

required

Show child attributes

data.deploymentLog.plan.outputChanges.attributes.name

string

required

data.deploymentLog.plan.outputChanges.attributes.before

any

data.deploymentLog.plan.outputChanges.attributes.after

any

data.deploymentLog.plan.outputChanges.moduleName

string

data.deploymentLog.planSummary

object

Show child attributes

data.deploymentLog.planSummary.added

number

required

data.deploymentLog.planSummary.changed

number

required

data.deploymentLog.planSummary.destroyed

number

required

data.deploymentLog.planSummary.imported

number

data.deploymentLog.isSkippedApply

boolean

data.deploymentLog.workflowDeploymentId

string

data.deploymentLog.workflowFile

object

Show child attributes

data.deploymentLog.workflowFile.environments

object

required

Show child attributes

data.deploymentLog.workflowFile.environments.{key}

object

Show child attributes

data.deploymentLog.workflowFile.environments.{key}.name

string

required

data.deploymentLog.workflowFile.environments.{key}.environmentId

string

data.deploymentLog.workflowFile.environments.{key}.toDestroy

boolean

data.deploymentLog.workflowFile.environments.{key}.isRemoteBackend

boolean

data.deploymentLog.workflowFile.environments.{key}.k8sNamespace

string

data.deploymentLog.workflowFile.environments.{key}.vcs

object

Show child attributes

data.deploymentLog.workflowFile.environments.{key}.vcs.type

enum<string>

required

Available options:

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible

data.deploymentLog.workflowFile.environments.{key}.vcs.repository

string

required

data.deploymentLog.workflowFile.environments.{key}.vcs.tokenName

string

data.deploymentLog.workflowFile.environments.{key}.vcs.tokenId

string

data.deploymentLog.workflowFile.environments.{key}.vcs.sshKeys

object[]

Show child attributes

data.deploymentLog.workflowFile.environments.{key}.vcs.sshKeys.id

string

required

Minimum string length: 1

data.deploymentLog.workflowFile.environments.{key}.vcs.sshKeys.name

string

required

data.deploymentLog.workflowFile.environments.{key}.vcs.githubInstallationId

data.deploymentLog.workflowFile.environments.{key}.vcs.bitbucketClientKey

data.deploymentLog.workflowFile.environments.{key}.vcs.isBitbucketServer

boolean

data.deploymentLog.workflowFile.environments.{key}.vcs.isGitLabEnterprise

boolean

data.deploymentLog.workflowFile.environments.{key}.vcs.isGitHubEnterprise

boolean

data.deploymentLog.workflowFile.environments.{key}.vcs.isGitLab

boolean

data.deploymentLog.workflowFile.environments.{key}.vcs.isAzureDevOps

boolean

data.deploymentLog.workflowFile.environments.{key}.vcs.isHelmRepository

boolean

data.deploymentLog.workflowFile.environments.{key}.vcs.vcsConnectionId

data.deploymentLog.workflowFile.environments.{key}.vcs.revision

string

data.deploymentLog.workflowFile.environments.{key}.vcs.path

string

data.deploymentLog.workflowFile.environments.{key}.vcs.fileName

string

data.deploymentLog.workflowFile.environments.{key}.vcs.helmChartName

string

data.deploymentLog.workflowFile.environments.{key}.vcs.terraformVersion

string

A string representing semantic version of Terraform. If set to "RESOLVE_FROM_TERRAFORM_CODE", the version will be determined by using tfenv's 'min-required'. When set to "latest", the version used will be the most recent one available for Terraform.

data.deploymentLog.workflowFile.environments.{key}.vcs.opentofuVersion

string

data.deploymentLog.workflowFile.environments.{key}.vcs.terragruntVersion

string

data.deploymentLog.workflowFile.environments.{key}.vcs.terragruntTfBinary

enum<string>

Available options:

terraform,

opentofu,

terraform,

opentofu,

terraform,

opentofu

data.deploymentLog.workflowFile.environments.{key}.vcs.pulumiVersion

string

data.deploymentLog.workflowFile.environments.{key}.vcs.ansibleVersion

string

data.deploymentLog.workflowFile.environments.{key}.templateName

string

data.deploymentLog.workflowFile.environments.{key}.templateId

string

data.deploymentLog.workflowFile.environments.{key}.templateType

enum<string>

Available options:

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible

data.deploymentLog.workflowFile.environments.{key}.revision

string

data.deploymentLog.workflowFile.environments.{key}.workspace

string

data.deploymentLog.workflowFile.environments.{key}.needs

string[]

data.deploymentLog.workflowFile.environments.{key}.terragruntWorkingDirectory

string

data.deploymentLog.workflowFile.environments.{key}.requiresApproval

boolean

data.deploymentLog.workflowFile.environments.{key}.disabled

data.deploymentLog.workflowFile.settings

object

Show child attributes

data.deploymentLog.workflowFile.settings.environmentRemovalStrategy

enum<string>

Available options:

destroy,

detach,

destroy,

detach

data.deploymentLog.workflowDeploymentOptions

object

Show child attributes

data.deploymentLog.workflowDeploymentOptions.node

string

required

data.deploymentLog.workflowDeploymentOptions.operation

enum<string>

required

Available options:

run-from-here,

single-node-deploy,

single-node-destroy,

run-from-here,

single-node-deploy,

single-node-destroy

data.deploymentLog.stateVersionId

string

data.deploymentLog.reviewedBy

string

data.deploymentLog.reviewedByUser

object

Show child attributes

data.deploymentLog.reviewedByUser.email

string

data.deploymentLog.reviewedByUser.user_id

string

data.deploymentLog.reviewedByUser.created_at

string

data.deploymentLog.reviewedByUser.app_metadata

object

data.deploymentLog.reviewedByUser.picture

string

data.deploymentLog.reviewedByUser.name

string

data.deploymentLog.reviewedByUser.given_name

string

data.deploymentLog.reviewedByUser.family_name

string

data.deploymentLog.targets

string[]

data.deploymentLog.variables

object[]

Show child attributes

data.deploymentLog.variables.name

string

required

data.deploymentLog.variables.scope

enum<string>

required

Available options:

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT,

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT,

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT,

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT,

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT

data.deploymentLog.variables.type

enum<number>

required

Whether it is an Environment or Terraform variable 0 value maps to an Environment variable 1 value maps to an Terraform variable

Available options:

0,

1,

0,

1,

0,

1,

0,

1,

0,

1

data.deploymentLog.variables.id

string

The ID of the configuration property. If provided, will act as an update. Otherwise, a new configuration property will be created.

data.deploymentLog.variables.scopeId

string

The ID of the entity of the provided scope. e.g. a project's ID when the provided scope is PROJECT. Inapplicable for GLOBAL scope, as it has no specific entity.

data.deploymentLog.variables.value

string

data.deploymentLog.variables.isSensitive

boolean

data.deploymentLog.variables.schema

object

type?: "string"
format: HCL | JSON | ENVIRONMENT_OUTPUT # default: null
- ENVIRONMENT_OUTPUT is a special type used to indicate that the value is an output from the environment. The value format is: ${env0::} it will be resolved before deployment.
enum?: ["option1", "option2"]
- Optional, for UI dropdown, works only without format. Note that if you want to update this list, you must provide the full updated list each time.

Show child attributes

data.deploymentLog.variables.schema.type

string

Allowed value: "string"

data.deploymentLog.variables.schema.enum

string[]

data.deploymentLog.variables.schema.format

enum<string>

Available options:

HCL,

JSON,

ENVIRONMENT_OUTPUT,

HCL,

JSON,

ENVIRONMENT_OUTPUT,

HCL,

JSON,

ENVIRONMENT_OUTPUT,

HCL,

JSON,

ENVIRONMENT_OUTPUT,

HCL,

JSON,

ENVIRONMENT_OUTPUT

data.deploymentLog.variables.userId

string

data.deploymentLog.variables.updatedAt

string<date-time>

data.deploymentLog.variables.projectId

string

data.deploymentLog.gitMetadata

object

Show child attributes

data.deploymentLog.gitMetadata.commit

string

required

data.deploymentLog.gitMetadata.branch

string

required

data.deploymentLog.gitMetadata.timestamp

string<date-time>

required

data.deploymentLog.providerVersions

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.deploymentLog.providerVersions.{key}

string

data.deploymentLog.moduleVersions

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.deploymentLog.moduleVersions.{key}

string

data.deploymentLog.stateFileHash

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.deploymentLog.stateFileHash.value

string

required

data.deploymentLog.driftCause

object

Show child attributes

data.deploymentLog.driftCause.unappliedCommits

object[]

required

Show child attributes

data.deploymentLog.driftCause.unappliedCommits.userEmail

string

required

data.deploymentLog.driftCause.unappliedCommits.timestamp

string<date-time>

required

data.deploymentLog.driftCause.unappliedCommits.commitHash

string

required

data.environment

object

required

Show child attributes

data.environment.url

string

required

data.environment.name

string

required

data.environment.organizationId

string

required

data.environment.projectId

string

required

data.environment.userId

string

required

data.environment.workspaceName

string

required

data.environment.user

object

required

Show child attributes

data.environment.user.email

string

data.environment.user.user_id

string

data.environment.user.created_at

string

data.environment.user.app_metadata

object

data.environment.user.picture

string

data.environment.user.name

string

data.environment.user.given_name

string

data.environment.user.family_name

string

data.environment.requiresApproval

boolean

required

data.environment.status

enum<string>

required

Available options:

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

data.environment.latestDeploymentLogId

string

required

data.environment.latestDeploymentLog

object

required

Show child attributes

data.environment.latestDeploymentLog.type

enum<string>

required

Available options:

deploy,

destroy,

prPlan,

driftDetection,

task,

remotePlan,

dryRun,

moduleTest,

deploy,

destroy,

prPlan,

driftDetection,

task,

remotePlan,

dryRun,

moduleTest

data.environment.latestDeploymentLog.startedBy

string

required

data.environment.latestDeploymentLog.queuedAt

string<date-time>

required

data.environment.latestDeploymentLog.startedAt

string<date-time>

required

data.environment.latestDeploymentLog.finishedAt

string<date-time>

required

data.environment.latestDeploymentLog.output

object

required

Option 1 · object
Option 2 · object[]
Option 3 · object
Option 4 · object[]

Show child attributes

data.environment.latestDeploymentLog.output.{key}

object

Show child attributes

data.environment.latestDeploymentLog.output.{key}.value

any

required

data.environment.latestDeploymentLog.output.{key}.sensitive

boolean

required

data.environment.latestDeploymentLog.output.{key}.type

string

required

data.environment.latestDeploymentLog.error

object

required

data.environment.latestDeploymentLog.costEstimation

object

required

Show child attributes

data.environment.latestDeploymentLog.costEstimation.totalMonthlyCost

number

required

data.environment.latestDeploymentLog.costEstimation.monthlyCostDiff

number

required

data.environment.latestDeploymentLog.costEstimation.projects

object[]

required

Show child attributes

data.environment.latestDeploymentLog.costEstimation.projects.diff

object

required

Show child attributes

data.environment.latestDeploymentLog.costEstimation.projects.diff.totalMonthlyCost

string

required

data.environment.latestDeploymentLog.status

enum<string>

required

Available options:

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

data.environment.latestDeploymentLog.blueprintId

string

required

data.environment.latestDeploymentLog.blueprintName

string

required

data.environment.latestDeploymentLog.blueprintRepository

string

required

data.environment.latestDeploymentLog.blueprintRevision

string

required

data.environment.latestDeploymentLog.blueprintPath

string

required

data.environment.latestDeploymentLog.blueprintType

enum<string>

required

Available options:

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

workflow,

module,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

workflow,

module

data.environment.latestDeploymentLog.environmentId

string

required

data.environment.latestDeploymentLog.resourceCount

number

required

data.environment.latestDeploymentLog.startedByUser

object

required

Show child attributes

data.environment.latestDeploymentLog.startedByUser.email

string

data.environment.latestDeploymentLog.startedByUser.user_id

string

data.environment.latestDeploymentLog.startedByUser.created_at

string

data.environment.latestDeploymentLog.startedByUser.app_metadata

object

data.environment.latestDeploymentLog.startedByUser.picture

string

data.environment.latestDeploymentLog.startedByUser.name

string

data.environment.latestDeploymentLog.startedByUser.given_name

string

data.environment.latestDeploymentLog.startedByUser.family_name

string

data.environment.latestDeploymentLog.isScheduledRun

boolean

required

data.environment.latestDeploymentLog.abortedBy

string

required

data.environment.latestDeploymentLog.abortedByUser

object

required

Show child attributes

data.environment.latestDeploymentLog.abortedByUser.email

string

data.environment.latestDeploymentLog.abortedByUser.user_id

string

data.environment.latestDeploymentLog.abortedByUser.created_at

string

data.environment.latestDeploymentLog.abortedByUser.app_metadata

object

data.environment.latestDeploymentLog.abortedByUser.picture

string

data.environment.latestDeploymentLog.abortedByUser.name

string

data.environment.latestDeploymentLog.abortedByUser.given_name

string

data.environment.latestDeploymentLog.abortedByUser.family_name

string

data.environment.latestDeploymentLog.reviewersUsers

object[]

required

Show child attributes

data.environment.latestDeploymentLog.reviewersUsers.user

object

required

Show child attributes

data.environment.latestDeploymentLog.reviewersUsers.user.email

string

data.environment.latestDeploymentLog.reviewersUsers.user.user_id

string

data.environment.latestDeploymentLog.reviewersUsers.user.created_at

string

data.environment.latestDeploymentLog.reviewersUsers.user.app_metadata

object

data.environment.latestDeploymentLog.reviewersUsers.user.picture

string

data.environment.latestDeploymentLog.reviewersUsers.user.name

string

data.environment.latestDeploymentLog.reviewersUsers.user.given_name

string

data.environment.latestDeploymentLog.reviewersUsers.user.family_name

string

data.environment.latestDeploymentLog.reviewersUsers.action

enum<string>

required

Available options:

approved,

cancelled,

approved,

cancelled

data.environment.latestDeploymentLog.reviewers

object[]

required

Show child attributes

data.environment.latestDeploymentLog.reviewers.userId

string

required

data.environment.latestDeploymentLog.reviewers.action

enum<string>

required

Available options:

approved,

cancelled,

approved,

cancelled

data.environment.latestDeploymentLog.id

string

data.environment.latestDeploymentLog.createdAt

string<date-time>

data.environment.latestDeploymentLog.updatedAt

string<date-time>

data.environment.latestDeploymentLog.failedCommand

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables

object

Show child attributes

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.environmentId

string

The deployed Environment ID

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.projectId

string

ENV0_PROJECT_ID

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.projectName

string

The Project Name of the deployed Environment

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.deploymentLogId

string

The deployment ID

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.deploymentType

enum<string>

The deployment type.

Available options:

deploy,

destroy,

prPlan,

deploy,

destroy,

prPlan,

deploy,

destroy,

prPlan

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.deploymentRevision

string

Available only when deployment revision defined

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.workspaceName

string

The Terraform Workspace name used in the Environment

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.rootDir

string

The root repository path

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.organizationId

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.templateId

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.templateDir

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.templateName

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.environmentName

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.environmentCreatorName

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.environmentCreatorUserId

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.environmentCreatorEmail

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.deployerName

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.deployerUserId

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.deployerEmail

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.reviewerName

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.reviewerEmail

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.reviewerUserId

string

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.vcsProvider

enum<string>

the vcs provider

Available options:

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.prAuthor

string

pr author. available only in PR Plan

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.prNumber

string

the pr number. available only in PR Plan

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.prSourceRepository

string

the source repository. available only in PR Plan for the VCSs supporting fork PR Plans)"

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.prSourceBranch

string

the source branch. available only in PR Plan

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.prTargetBranch

string

the target branch. available only in PR Plan

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.commitHash

string

the commit hash

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.commitUrl

string

the commit url

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.oidcToken

string

The OIDC Token - read more here(https://docs.env0.com/docs/oidc-integrations) on how to enable it and use it

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.vcsAccessToken

string

When using a native VCS integration, this will represent the access token we use to clone the repository

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.tfPlanJson

string

The file path to a JSON representation of a Terraform Plan file

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.cliArgsPlan

string

add additional cli arguments when running a plan

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.cliArgsApply

string

add additional cli arguments when running the apply command

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.discoveryRepositoryUrl

string

Repository URL to write PR comments to. Used for prPlan deployments to override the target repo for comments.

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.discoveryPrNumber

string

PR number to write comments to. Used for prPlan deployments to override the target PR.

data.environment.latestDeploymentLog.customEnv0EnvironmentVariables.discoveryVCS

enum<string>

Discovery VCS provider (e.g., 'github')

Available options:

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps,

gitlab,

github,

bitbucket,

bitbucketServer,

gitlabEnterprise,

githubEnterprise,

azureDevOps

data.environment.latestDeploymentLog.comment

string

data.environment.latestDeploymentLog.resources

object[]

Show child attributes

data.environment.latestDeploymentLog.resources.provider

string

required

data.environment.latestDeploymentLog.resources.type

string

required

data.environment.latestDeploymentLog.resources.name

string

required

data.environment.latestDeploymentLog.resources.moduleName

string

data.environment.latestDeploymentLog.gitUser

string

data.environment.latestDeploymentLog.gitAvatarUrl

string

data.environment.latestDeploymentLog.prNumber

string

data.environment.latestDeploymentLog.triggerName

Available options:

user,

terraform-cli,

workflow,

user,

terraform-cli,

workflow,

user,

terraform-cli,

workflow

data.environment.latestDeploymentLog.driftDetected

boolean

data.environment.latestDeploymentLog.plan

object

Show child attributes

data.environment.latestDeploymentLog.plan.resourceChanges

object[]

required

Show child attributes

data.environment.latestDeploymentLog.plan.resourceChanges.name

string

required

data.environment.latestDeploymentLog.plan.resourceChanges.providerName

string

required

data.environment.latestDeploymentLog.plan.resourceChanges.type

string

required

data.environment.latestDeploymentLog.plan.resourceChanges.path

string

required

data.environment.latestDeploymentLog.plan.resourceChanges.action

enum<string>

required

Available options:

create,

update,

delete,

recreate,

metadata,

create,

update,

delete,

recreate,

metadata

data.environment.latestDeploymentLog.plan.resourceChanges.attributes

object[]

required

Show child attributes

data.environment.latestDeploymentLog.plan.resourceChanges.attributes.name

string

required

data.environment.latestDeploymentLog.plan.resourceChanges.attributes.before

any

data.environment.latestDeploymentLog.plan.resourceChanges.attributes.after

any

data.environment.latestDeploymentLog.plan.resourceChanges.id

string

data.environment.latestDeploymentLog.plan.resourceChanges.cloudId

string

data.environment.latestDeploymentLog.plan.resourceChanges.moduleName

string

data.environment.latestDeploymentLog.plan.resourceChanges.driftByCloud

boolean

data.environment.latestDeploymentLog.plan.resourceChanges.importing

object

Show child attributes

data.environment.latestDeploymentLog.plan.resourceChanges.importing.id

string

required

data.environment.latestDeploymentLog.plan.resourceChanges.actionReason

enum<string>

Available options:

replace_because_tainted,

replace_because_cannot_update,

replace_by_request,

delete_because_no_resource_config,

delete_because_no_module,

delete_because_wrong_repetition,

delete_because_count_index,

delete_because_each_key,

read_because_config_unknown,

read_because_dependency_pending,

replace_because_tainted,

replace_because_cannot_update,

replace_by_request,

delete_because_no_resource_config,

delete_because_no_module,

delete_because_wrong_repetition,

delete_because_count_index,

delete_because_each_key,

read_because_config_unknown,

read_because_dependency_pending

data.environment.latestDeploymentLog.plan.resourceChanges.createBeforeDestroy

boolean

data.environment.latestDeploymentLog.plan.resourceChanges.previousAddress

string

data.environment.latestDeploymentLog.plan.outputChanges

object[]

required

Show child attributes

data.environment.latestDeploymentLog.plan.outputChanges.name

string

required

data.environment.latestDeploymentLog.plan.outputChanges.action

enum<string>

required

Available options:

create,

update,

delete,

recreate,

metadata,

create,

update,

delete,

recreate,

metadata

data.environment.latestDeploymentLog.plan.outputChanges.attributes

object[]

required

Show child attributes

data.environment.latestDeploymentLog.plan.outputChanges.attributes.name

string

required

data.environment.latestDeploymentLog.plan.outputChanges.attributes.before

any

data.environment.latestDeploymentLog.plan.outputChanges.attributes.after

any

data.environment.latestDeploymentLog.plan.outputChanges.moduleName

string

data.environment.latestDeploymentLog.planSummary

object

Show child attributes

data.environment.latestDeploymentLog.planSummary.added

number

required

data.environment.latestDeploymentLog.planSummary.changed

number

required

data.environment.latestDeploymentLog.planSummary.destroyed

number

required

data.environment.latestDeploymentLog.planSummary.imported

number

data.environment.latestDeploymentLog.isSkippedApply

boolean

data.environment.latestDeploymentLog.workflowDeploymentId

string

data.environment.latestDeploymentLog.workflowFile

object

Show child attributes

data.environment.latestDeploymentLog.workflowFile.environments

object

required

Show child attributes

data.environment.latestDeploymentLog.workflowFile.environments.{key}

object

Show child attributes

data.environment.latestDeploymentLog.workflowFile.environments.{key}.name

string

required

data.environment.latestDeploymentLog.workflowFile.environments.{key}.environmentId

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.toDestroy

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.isRemoteBackend

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.k8sNamespace

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs

object

Show child attributes

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.type

enum<string>

required

Available options:

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.repository

string

required

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.tokenName

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.tokenId

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.sshKeys

object[]

Show child attributes

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.sshKeys.id

string

required

Minimum string length: 1

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.sshKeys.name

string

required

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.githubInstallationId

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.bitbucketClientKey

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.isBitbucketServer

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.isGitLabEnterprise

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.isGitHubEnterprise

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.isGitLab

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.isAzureDevOps

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.isHelmRepository

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.vcsConnectionId

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.revision

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.path

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.fileName

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.helmChartName

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.terraformVersion

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.opentofuVersion

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.terragruntVersion

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.terragruntTfBinary

enum<string>

Available options:

terraform,

opentofu,

terraform,

opentofu,

terraform,

opentofu

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.pulumiVersion

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.vcs.ansibleVersion

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.templateName

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.templateId

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.templateType

enum<string>

Available options:

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible

data.environment.latestDeploymentLog.workflowFile.environments.{key}.revision

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.workspace

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.needs

string[]

data.environment.latestDeploymentLog.workflowFile.environments.{key}.terragruntWorkingDirectory

string

data.environment.latestDeploymentLog.workflowFile.environments.{key}.requiresApproval

boolean

data.environment.latestDeploymentLog.workflowFile.environments.{key}.disabled

data.environment.latestDeploymentLog.workflowFile.settings

object

Show child attributes

data.environment.latestDeploymentLog.workflowFile.settings.environmentRemovalStrategy

enum<string>

Available options:

destroy,

detach,

destroy,

detach

data.environment.latestDeploymentLog.workflowDeploymentOptions

object

Show child attributes

data.environment.latestDeploymentLog.workflowDeploymentOptions.node

string

required

data.environment.latestDeploymentLog.workflowDeploymentOptions.operation

enum<string>

required

Available options:

run-from-here,

single-node-deploy,

single-node-destroy,

run-from-here,

single-node-deploy,

single-node-destroy

data.environment.latestDeploymentLog.stateVersionId

string

data.environment.latestDeploymentLog.reviewedBy

string

data.environment.latestDeploymentLog.reviewedByUser

object

Show child attributes

data.environment.latestDeploymentLog.reviewedByUser.email

string

data.environment.latestDeploymentLog.reviewedByUser.user_id

string

data.environment.latestDeploymentLog.reviewedByUser.created_at

string

data.environment.latestDeploymentLog.reviewedByUser.app_metadata

object

data.environment.latestDeploymentLog.reviewedByUser.picture

string

data.environment.latestDeploymentLog.reviewedByUser.name

string

data.environment.latestDeploymentLog.reviewedByUser.given_name

string

data.environment.latestDeploymentLog.reviewedByUser.family_name

string

data.environment.latestDeploymentLog.targets

string[]

data.environment.latestDeploymentLog.variables

object[]

Show child attributes

data.environment.latestDeploymentLog.variables.name

string

required

data.environment.latestDeploymentLog.variables.scope

enum<string>

required

Available options:

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT,

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT,

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT,

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT,

SET,

GLOBAL,

BLUEPRINT,

SUB_ENVIRONMENT_BLUEPRINT,

PROJECT,

WORKFLOW,

ENVIRONMENT,

DEPLOYMENT

data.environment.latestDeploymentLog.variables.type

enum<number>

required

Whether it is an Environment or Terraform variable 0 value maps to an Environment variable 1 value maps to an Terraform variable

Available options:

0,

1,

0,

1,

0,

1,

0,

1,

0,

1

data.environment.latestDeploymentLog.variables.id

string

The ID of the configuration property. If provided, will act as an update. Otherwise, a new configuration property will be created.

data.environment.latestDeploymentLog.variables.scopeId

string

The ID of the entity of the provided scope. e.g. a project's ID when the provided scope is PROJECT. Inapplicable for GLOBAL scope, as it has no specific entity.

data.environment.latestDeploymentLog.variables.value

string

data.environment.latestDeploymentLog.variables.isSensitive

boolean

data.environment.latestDeploymentLog.variables.schema

object

type?: "string"
format: HCL | JSON | ENVIRONMENT_OUTPUT # default: null
- ENVIRONMENT_OUTPUT is a special type used to indicate that the value is an output from the environment. The value format is: ${env0::} it will be resolved before deployment.
enum?: ["option1", "option2"]
- Optional, for UI dropdown, works only without format. Note that if you want to update this list, you must provide the full updated list each time.

Show child attributes

data.environment.latestDeploymentLog.variables.schema.type

string

Allowed value: "string"

data.environment.latestDeploymentLog.variables.schema.enum

string[]

data.environment.latestDeploymentLog.variables.schema.format

enum<string>

Available options:

HCL,

JSON,

ENVIRONMENT_OUTPUT,

HCL,

JSON,

ENVIRONMENT_OUTPUT,

HCL,

JSON,

ENVIRONMENT_OUTPUT,

HCL,

JSON,

ENVIRONMENT_OUTPUT,

HCL,

JSON,

ENVIRONMENT_OUTPUT

data.environment.latestDeploymentLog.variables.userId

string

data.environment.latestDeploymentLog.variables.updatedAt

string<date-time>

data.environment.latestDeploymentLog.variables.projectId

string

data.environment.latestDeploymentLog.gitMetadata

object

Show child attributes

data.environment.latestDeploymentLog.gitMetadata.commit

string

required

data.environment.latestDeploymentLog.gitMetadata.branch

string

required

data.environment.latestDeploymentLog.gitMetadata.timestamp

string<date-time>

required

data.environment.latestDeploymentLog.providerVersions

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.environment.latestDeploymentLog.providerVersions.{key}

string

data.environment.latestDeploymentLog.moduleVersions

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.environment.latestDeploymentLog.moduleVersions.{key}

string

data.environment.latestDeploymentLog.stateFileHash

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.environment.latestDeploymentLog.stateFileHash.value

string

required

data.environment.latestDeploymentLog.driftCause

object

Show child attributes

data.environment.latestDeploymentLog.driftCause.unappliedCommits

object[]

required

Show child attributes

data.environment.latestDeploymentLog.driftCause.unappliedCommits.userEmail

string

required

data.environment.latestDeploymentLog.driftCause.unappliedCommits.timestamp

string<date-time>

required

data.environment.latestDeploymentLog.driftCause.unappliedCommits.commitHash

string

required

data.environment.lifespanEndAt

string<date-time>

required

data.environment.markedForAutoDestroy

enum<number>

required

Available options:

0,

1,

2,

3,

0,

1,

2,

3

data.environment.isArchived

boolean

required

Mark the environment as inactive

data.environment.nextScheduledDates

object

required

Show child attributes

data.environment.nextScheduledDates.deploy

string<date-time>

data.environment.nextScheduledDates.destroy

string<date-time>

data.environment.continuousDeployment

boolean

required

data.environment.pullRequestPlanDeployments

boolean

required

data.environment.autoDeployOnPathChangesOnly

boolean

required

data.environment.isRemoteBackend

boolean

required

data.environment.isLocked

boolean

required

data.environment.driftStatus

enum<string>

required

Available options:

ERROR,

DRIFTED,

OK,

NEVER_RUN,

DISABLED,

ERROR,

DRIFTED,

OK,

NEVER_RUN,

DISABLED,

ERROR,

DRIFTED,

OK,

NEVER_RUN,

DISABLED

data.environment.id

string

data.environment.createdAt

string<date-time>

data.environment.updatedAt

string<date-time>

data.environment.vcsCommandsAlias

string

data.environment.vcsPrCommentsEnabled

boolean

data.environment.autoDeployByCustomGlob

string

data.environment.terragruntWorkingDirectory

string

data.environment.isSingleUseBlueprint

boolean

data.environment.workflowEnvironmentId

string

data.environment.lockStatus

object

Show child attributes

data.environment.lockStatus.updatedBy

string

required

data.environment.lockStatus.updatedAt

string<date-time>

required

data.environment.lockStatus.reason

string

data.environment.lockStatus.updatedByUser

object

Show child attributes

data.environment.lockStatus.updatedByUser.email

string

data.environment.lockStatus.updatedByUser.user_id

string

data.environment.lockStatus.updatedByUser.created_at

string

data.environment.lockStatus.updatedByUser.app_metadata

object

data.environment.lockStatus.updatedByUser.picture

string

data.environment.lockStatus.updatedByUser.name

string

data.environment.lockStatus.updatedByUser.given_name

string

data.environment.lockStatus.updatedByUser.family_name

string

data.environment.k8sNamespace

string

data.environment.isRemoteApplyEnabled

boolean

data.project

object

required

Show child attributes

data.project.url

string

required

data.project.name

string

required

data.project.organizationId

string

required

data.project.createdBy

string

required

data.project.hierarchy

string

required

data.project.description

string

data.project.parentProjectId

string

data.project.id

string

data.project.createdByUser

object

Show child attributes

data.project.createdByUser.email

string

data.project.createdByUser.user_id

string

data.project.createdByUser.created_at

string

data.project.createdByUser.app_metadata

object

data.project.createdByUser.picture

string

data.project.createdByUser.name

string

data.project.createdByUser.given_name

string

data.project.createdByUser.family_name

string

data.project.isArchived

boolean

data.organization

object

required

Show child attributes

data.organization.url

string

required

data.organization.projectCustomFlowsPolicy

enum<string>

required

Available options:

MERGE_WITH_TEMPLATES,

OVERRIDE_TEMPLATES,

MERGE_WITH_TEMPLATES,

OVERRIDE_TEMPLATES

data.organization.id

string

required

data.organization.name

string

required

data.organization.createdBy

string

required

data.organization.mode

enum<string>

required

Available options:

paying,

trial,

free,

paying,

trial,

free

data.organization.role

string

required

data.organization.maxTtl

string | null

The maximum allowed TTL. Must be 6-h, 12-h, 1-d, 3-d, 1-w, 2-w, 1-M, inherit or explicit null which means infinite

data.organization.defaultTtl

string | null

The default TTL set when creating environments. Must be 6-h, 12-h, 1-d, 3-d, 1-w, 2-w, 1-M, inherit or explicit null which means infinite

data.organization.doNotReportSkippedStatusChecks

boolean

data.organization.doNotConsiderMergeCommitsForPrPlans

boolean

data.organization.enableOidc

boolean

data.organization.enforcePrCommenterPermissions

boolean

data.organization.allowEnv0Secrets

boolean

data.organization.requireApprovalForPrApplies

boolean

data.organization.disablePrComments

boolean

data.organization.description

string

data.organization.photoUrl

string

data.organization.createdAt

string<date-time>

data.organization.updatedAt

string<date-time>

data.organization.trialEnd

string<date-time>

data.organization.isSelfHostedK8s

boolean

data.blueprint

object

required

Show child attributes

data.blueprint.url

string

required

data.blueprint.name

string

required

data.blueprint.creationScopeId

string

required

data.blueprint.creationScope

enum<string>

required

Available options:

ORGANIZATION,

PROJECT,

ORGANIZATION,

PROJECT,

ORGANIZATION,

PROJECT

data.blueprint.repository

string

required

data.blueprint.type

enum<string>

required

Available options:

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

workflow,

module,

approval-policy,

custom-flow,

environment-discovery,

discovery-config,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

workflow,

module,

approval-policy,

custom-flow,

environment-discovery,

discovery-config,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

workflow,

module,

approval-policy,

custom-flow,

environment-discovery,

discovery-config,

opentofu,

terraform,

terragrunt,

pulumi,

k8s,

cloudformation,

helm,

ansible,

workflow,

module,

approval-policy,

custom-flow,

environment-discovery,

discovery-config

data.blueprint.organizationId

string

required

data.blueprint.description

string

data.blueprint.retry

object

Show child attributes

data.blueprint.retry.onDestroy

object

Option 1
Option 2
Option 3

Show child attributes

data.blueprint.retry.onDestroy.times

number

required

data.blueprint.retry.onDestroy.errorRegex

string

data.blueprint.retry.onDeploy

object

Option 1
Option 2
Option 3

Show child attributes

data.blueprint.retry.onDeploy.times

number

required

data.blueprint.retry.onDeploy.errorRegex

string

data.blueprint.runTestsOnPullRequest

boolean

data.blueprint.isTerragruntRunAll

boolean

data.blueprint.projectIds

string[]

data.blueprint.tagPrefix

string

data.blueprint.revision

string

data.blueprint.path

string

data.blueprint.fileName

string

data.blueprint.helmChartName

string

data.blueprint.terraformVersion

string

data.blueprint.opentofuVersion

string

data.blueprint.terragruntVersion

string

data.blueprint.terragruntTfBinary

enum<string>

Available options:

terraform,

opentofu,

terraform,

opentofu,

terraform,

opentofu

data.blueprint.pulumiVersion

string

data.blueprint.ansibleVersion

string

data.blueprint.tokenName

string

data.blueprint.tokenId

string

data.blueprint.sshKeys

object[]

Show child attributes

data.blueprint.sshKeys.id

string

required

Minimum string length: 1

data.blueprint.sshKeys.name

string

required

data.blueprint.githubInstallationId

number | null

data.blueprint.bitbucketClientKey

string | null

data.blueprint.isBitbucketServer

boolean

data.blueprint.isGitLabEnterprise

boolean

data.blueprint.isGitHubEnterprise

boolean

data.blueprint.isGitLab

boolean

data.blueprint.isAzureDevOps

boolean

data.blueprint.isHelmRepository

boolean

data.blueprint.vcsConnectionId

string | null

data.blueprint.id

string

data.blueprint.author

object

Show child attributes

data.blueprint.author.email

string

data.blueprint.author.user_id

string

data.blueprint.author.created_at

string

data.blueprint.author.app_metadata

object

data.blueprint.author.picture

string

data.blueprint.author.name

string

data.blueprint.author.given_name

string

data.blueprint.author.family_name

string

data.blueprint.createdAt

string<date-time>

data.blueprint.updatedAt

string<date-time>

data.blueprint.isDeleted

boolean

data.blueprint.authorId

string

data.blueprint.projectId

string

data.blueprint.isSingleUse

boolean

data.gitRevision

string

Response

200

Return a 200 status to indicate that the data was received successfully

Getting Started

Users

Agents Settings

Audit Events

Templates

Modules

Custom Flow

Approval Policy

Bulk Operations

Cloud Compass

Code-Optimizer (BETA)

Configuration

Cost

Credentials

Dashboard

Deployment Logs

Environment Import

Environment Outputs

Environments

Projects

Notifications

Organization

Provider Registry

Remote Backend

Roles

Scheduling

Teams

VCS

Role Based Access

Webhooks

Authorizations

Creating an API Key with a Specific Role

Creating a Personal API Key

Using an API Key to Authenticate

API Key Permissions

Rate Limits

Body

Response