Deploy Environment
curl --request POST \
--url https://api.env0.com/environments/{id}/deployments \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"workflowDeploymentId": "<string>",
"blueprintId": "<string>",
"blueprintRevision": "<string>",
"blueprintRepository": "<string>",
"configurationChanges": {
"name": "<string>",
"value": "<string>",
"id": "<string>",
"isSensitive": true,
"isReadonly": true,
"isRequired": true,
"regex": "<string>",
"toDelete": true,
"projectId": "<string>",
"schema": {
"enum": [
"<string>"
]
},
"description": "<string>",
"isOutput": true
},
"configurationSetChanges": {
"assign": [
"<string>"
],
"unassign": [
"<string>"
]
},
"envName": "<string>",
"userRequiresApproval": true,
"targets": [
"<string>"
],
"customEnv0EnvironmentVariables": {
"environmentId": "<string>",
"projectId": "<string>",
"projectName": "<string>",
"parentProjectIds": "<string>",
"parentProjectPath": "<string>",
"deploymentLogId": "<string>",
"deploymentRevision": "<string>",
"workspaceName": "<string>",
"rootDir": "<string>",
"organizationId": "<string>",
"templateId": "<string>",
"templateDir": "<string>",
"templateName": "<string>",
"environmentName": "<string>",
"environmentCreatorName": "<string>",
"environmentCreatorUserId": "<string>",
"environmentCreatorEmail": "<string>",
"deployerName": "<string>",
"deployerUserId": "<string>",
"deployerEmail": "<string>",
"reviewerName": "<string>",
"reviewerEmail": "<string>",
"reviewerUserId": "<string>",
"prAuthor": "<string>",
"prNumber": "<string>",
"prSourceRepository": "<string>",
"prSourceBranch": "<string>",
"prTargetBranch": "<string>",
"commitHash": "<string>",
"commitUrl": "<string>",
"oidcToken": "<string>",
"vcsAccessToken": "<string>",
"tfPlanJson": "<string>",
"cliArgsPlan": "<string>",
"cliArgsApply": "<string>",
"discoveryRepositoryUrl": "<string>",
"discoveryPrNumber": "<string>"
},
"gitUserData": {
"gitUser": "<string>",
"gitAvatarUrl": "<string>",
"prNumber": "<string>"
},
"comment": "<string>",
"upstreamEnvironmentId": "<string>",
"taskPayload": "<string>",
"subEnvironments": {},
"subEnvironmentAlias": "<string>"
}
'import requests
url = "https://api.env0.com/environments/{id}/deployments"
payload = {
"workflowDeploymentId": "<string>",
"blueprintId": "<string>",
"blueprintRevision": "<string>",
"blueprintRepository": "<string>",
"configurationChanges": {
"name": "<string>",
"value": "<string>",
"id": "<string>",
"isSensitive": True,
"isReadonly": True,
"isRequired": True,
"regex": "<string>",
"toDelete": True,
"projectId": "<string>",
"schema": { "enum": ["<string>"] },
"description": "<string>",
"isOutput": True
},
"configurationSetChanges": {
"assign": ["<string>"],
"unassign": ["<string>"]
},
"envName": "<string>",
"userRequiresApproval": True,
"targets": ["<string>"],
"customEnv0EnvironmentVariables": {
"environmentId": "<string>",
"projectId": "<string>",
"projectName": "<string>",
"parentProjectIds": "<string>",
"parentProjectPath": "<string>",
"deploymentLogId": "<string>",
"deploymentRevision": "<string>",
"workspaceName": "<string>",
"rootDir": "<string>",
"organizationId": "<string>",
"templateId": "<string>",
"templateDir": "<string>",
"templateName": "<string>",
"environmentName": "<string>",
"environmentCreatorName": "<string>",
"environmentCreatorUserId": "<string>",
"environmentCreatorEmail": "<string>",
"deployerName": "<string>",
"deployerUserId": "<string>",
"deployerEmail": "<string>",
"reviewerName": "<string>",
"reviewerEmail": "<string>",
"reviewerUserId": "<string>",
"prAuthor": "<string>",
"prNumber": "<string>",
"prSourceRepository": "<string>",
"prSourceBranch": "<string>",
"prTargetBranch": "<string>",
"commitHash": "<string>",
"commitUrl": "<string>",
"oidcToken": "<string>",
"vcsAccessToken": "<string>",
"tfPlanJson": "<string>",
"cliArgsPlan": "<string>",
"cliArgsApply": "<string>",
"discoveryRepositoryUrl": "<string>",
"discoveryPrNumber": "<string>"
},
"gitUserData": {
"gitUser": "<string>",
"gitAvatarUrl": "<string>",
"prNumber": "<string>"
},
"comment": "<string>",
"upstreamEnvironmentId": "<string>",
"taskPayload": "<string>",
"subEnvironments": {},
"subEnvironmentAlias": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflowDeploymentId: '<string>',
blueprintId: '<string>',
blueprintRevision: '<string>',
blueprintRepository: '<string>',
configurationChanges: {
name: '<string>',
value: '<string>',
id: '<string>',
isSensitive: true,
isReadonly: true,
isRequired: true,
regex: '<string>',
toDelete: true,
projectId: '<string>',
schema: {enum: ['<string>']},
description: '<string>',
isOutput: true
},
configurationSetChanges: {assign: ['<string>'], unassign: ['<string>']},
envName: '<string>',
userRequiresApproval: true,
targets: ['<string>'],
customEnv0EnvironmentVariables: {
environmentId: '<string>',
projectId: '<string>',
projectName: '<string>',
parentProjectIds: '<string>',
parentProjectPath: '<string>',
deploymentLogId: '<string>',
deploymentRevision: '<string>',
workspaceName: '<string>',
rootDir: '<string>',
organizationId: '<string>',
templateId: '<string>',
templateDir: '<string>',
templateName: '<string>',
environmentName: '<string>',
environmentCreatorName: '<string>',
environmentCreatorUserId: '<string>',
environmentCreatorEmail: '<string>',
deployerName: '<string>',
deployerUserId: '<string>',
deployerEmail: '<string>',
reviewerName: '<string>',
reviewerEmail: '<string>',
reviewerUserId: '<string>',
prAuthor: '<string>',
prNumber: '<string>',
prSourceRepository: '<string>',
prSourceBranch: '<string>',
prTargetBranch: '<string>',
commitHash: '<string>',
commitUrl: '<string>',
oidcToken: '<string>',
vcsAccessToken: '<string>',
tfPlanJson: '<string>',
cliArgsPlan: '<string>',
cliArgsApply: '<string>',
discoveryRepositoryUrl: '<string>',
discoveryPrNumber: '<string>'
},
gitUserData: {gitUser: '<string>', gitAvatarUrl: '<string>', prNumber: '<string>'},
comment: '<string>',
upstreamEnvironmentId: '<string>',
taskPayload: '<string>',
subEnvironments: {},
subEnvironmentAlias: '<string>'
})
};
fetch('https://api.env0.com/environments/{id}/deployments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.env0.com/environments/{id}/deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workflowDeploymentId' => '<string>',
'blueprintId' => '<string>',
'blueprintRevision' => '<string>',
'blueprintRepository' => '<string>',
'configurationChanges' => [
'name' => '<string>',
'value' => '<string>',
'id' => '<string>',
'isSensitive' => true,
'isReadonly' => true,
'isRequired' => true,
'regex' => '<string>',
'toDelete' => true,
'projectId' => '<string>',
'schema' => [
'enum' => [
'<string>'
]
],
'description' => '<string>',
'isOutput' => true
],
'configurationSetChanges' => [
'assign' => [
'<string>'
],
'unassign' => [
'<string>'
]
],
'envName' => '<string>',
'userRequiresApproval' => true,
'targets' => [
'<string>'
],
'customEnv0EnvironmentVariables' => [
'environmentId' => '<string>',
'projectId' => '<string>',
'projectName' => '<string>',
'parentProjectIds' => '<string>',
'parentProjectPath' => '<string>',
'deploymentLogId' => '<string>',
'deploymentRevision' => '<string>',
'workspaceName' => '<string>',
'rootDir' => '<string>',
'organizationId' => '<string>',
'templateId' => '<string>',
'templateDir' => '<string>',
'templateName' => '<string>',
'environmentName' => '<string>',
'environmentCreatorName' => '<string>',
'environmentCreatorUserId' => '<string>',
'environmentCreatorEmail' => '<string>',
'deployerName' => '<string>',
'deployerUserId' => '<string>',
'deployerEmail' => '<string>',
'reviewerName' => '<string>',
'reviewerEmail' => '<string>',
'reviewerUserId' => '<string>',
'prAuthor' => '<string>',
'prNumber' => '<string>',
'prSourceRepository' => '<string>',
'prSourceBranch' => '<string>',
'prTargetBranch' => '<string>',
'commitHash' => '<string>',
'commitUrl' => '<string>',
'oidcToken' => '<string>',
'vcsAccessToken' => '<string>',
'tfPlanJson' => '<string>',
'cliArgsPlan' => '<string>',
'cliArgsApply' => '<string>',
'discoveryRepositoryUrl' => '<string>',
'discoveryPrNumber' => '<string>'
],
'gitUserData' => [
'gitUser' => '<string>',
'gitAvatarUrl' => '<string>',
'prNumber' => '<string>'
],
'comment' => '<string>',
'upstreamEnvironmentId' => '<string>',
'taskPayload' => '<string>',
'subEnvironments' => [
],
'subEnvironmentAlias' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.env0.com/environments/{id}/deployments"
payload := strings.NewReader("{\n \"workflowDeploymentId\": \"<string>\",\n \"blueprintId\": \"<string>\",\n \"blueprintRevision\": \"<string>\",\n \"blueprintRepository\": \"<string>\",\n \"configurationChanges\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"isSensitive\": true,\n \"isReadonly\": true,\n \"isRequired\": true,\n \"regex\": \"<string>\",\n \"toDelete\": true,\n \"projectId\": \"<string>\",\n \"schema\": {\n \"enum\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"isOutput\": true\n },\n \"configurationSetChanges\": {\n \"assign\": [\n \"<string>\"\n ],\n \"unassign\": [\n \"<string>\"\n ]\n },\n \"envName\": \"<string>\",\n \"userRequiresApproval\": true,\n \"targets\": [\n \"<string>\"\n ],\n \"customEnv0EnvironmentVariables\": {\n \"environmentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"projectName\": \"<string>\",\n \"parentProjectIds\": \"<string>\",\n \"parentProjectPath\": \"<string>\",\n \"deploymentLogId\": \"<string>\",\n \"deploymentRevision\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"rootDir\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateDir\": \"<string>\",\n \"templateName\": \"<string>\",\n \"environmentName\": \"<string>\",\n \"environmentCreatorName\": \"<string>\",\n \"environmentCreatorUserId\": \"<string>\",\n \"environmentCreatorEmail\": \"<string>\",\n \"deployerName\": \"<string>\",\n \"deployerUserId\": \"<string>\",\n \"deployerEmail\": \"<string>\",\n \"reviewerName\": \"<string>\",\n \"reviewerEmail\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"prAuthor\": \"<string>\",\n \"prNumber\": \"<string>\",\n \"prSourceRepository\": \"<string>\",\n \"prSourceBranch\": \"<string>\",\n \"prTargetBranch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitUrl\": \"<string>\",\n \"oidcToken\": \"<string>\",\n \"vcsAccessToken\": \"<string>\",\n \"tfPlanJson\": \"<string>\",\n \"cliArgsPlan\": \"<string>\",\n \"cliArgsApply\": \"<string>\",\n \"discoveryRepositoryUrl\": \"<string>\",\n \"discoveryPrNumber\": \"<string>\"\n },\n \"gitUserData\": {\n \"gitUser\": \"<string>\",\n \"gitAvatarUrl\": \"<string>\",\n \"prNumber\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"upstreamEnvironmentId\": \"<string>\",\n \"taskPayload\": \"<string>\",\n \"subEnvironments\": {},\n \"subEnvironmentAlias\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.env0.com/environments/{id}/deployments")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"workflowDeploymentId\": \"<string>\",\n \"blueprintId\": \"<string>\",\n \"blueprintRevision\": \"<string>\",\n \"blueprintRepository\": \"<string>\",\n \"configurationChanges\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"isSensitive\": true,\n \"isReadonly\": true,\n \"isRequired\": true,\n \"regex\": \"<string>\",\n \"toDelete\": true,\n \"projectId\": \"<string>\",\n \"schema\": {\n \"enum\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"isOutput\": true\n },\n \"configurationSetChanges\": {\n \"assign\": [\n \"<string>\"\n ],\n \"unassign\": [\n \"<string>\"\n ]\n },\n \"envName\": \"<string>\",\n \"userRequiresApproval\": true,\n \"targets\": [\n \"<string>\"\n ],\n \"customEnv0EnvironmentVariables\": {\n \"environmentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"projectName\": \"<string>\",\n \"parentProjectIds\": \"<string>\",\n \"parentProjectPath\": \"<string>\",\n \"deploymentLogId\": \"<string>\",\n \"deploymentRevision\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"rootDir\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateDir\": \"<string>\",\n \"templateName\": \"<string>\",\n \"environmentName\": \"<string>\",\n \"environmentCreatorName\": \"<string>\",\n \"environmentCreatorUserId\": \"<string>\",\n \"environmentCreatorEmail\": \"<string>\",\n \"deployerName\": \"<string>\",\n \"deployerUserId\": \"<string>\",\n \"deployerEmail\": \"<string>\",\n \"reviewerName\": \"<string>\",\n \"reviewerEmail\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"prAuthor\": \"<string>\",\n \"prNumber\": \"<string>\",\n \"prSourceRepository\": \"<string>\",\n \"prSourceBranch\": \"<string>\",\n \"prTargetBranch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitUrl\": \"<string>\",\n \"oidcToken\": \"<string>\",\n \"vcsAccessToken\": \"<string>\",\n \"tfPlanJson\": \"<string>\",\n \"cliArgsPlan\": \"<string>\",\n \"cliArgsApply\": \"<string>\",\n \"discoveryRepositoryUrl\": \"<string>\",\n \"discoveryPrNumber\": \"<string>\"\n },\n \"gitUserData\": {\n \"gitUser\": \"<string>\",\n \"gitAvatarUrl\": \"<string>\",\n \"prNumber\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"upstreamEnvironmentId\": \"<string>\",\n \"taskPayload\": \"<string>\",\n \"subEnvironments\": {},\n \"subEnvironmentAlias\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.env0.com/environments/{id}/deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflowDeploymentId\": \"<string>\",\n \"blueprintId\": \"<string>\",\n \"blueprintRevision\": \"<string>\",\n \"blueprintRepository\": \"<string>\",\n \"configurationChanges\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"isSensitive\": true,\n \"isReadonly\": true,\n \"isRequired\": true,\n \"regex\": \"<string>\",\n \"toDelete\": true,\n \"projectId\": \"<string>\",\n \"schema\": {\n \"enum\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"isOutput\": true\n },\n \"configurationSetChanges\": {\n \"assign\": [\n \"<string>\"\n ],\n \"unassign\": [\n \"<string>\"\n ]\n },\n \"envName\": \"<string>\",\n \"userRequiresApproval\": true,\n \"targets\": [\n \"<string>\"\n ],\n \"customEnv0EnvironmentVariables\": {\n \"environmentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"projectName\": \"<string>\",\n \"parentProjectIds\": \"<string>\",\n \"parentProjectPath\": \"<string>\",\n \"deploymentLogId\": \"<string>\",\n \"deploymentRevision\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"rootDir\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateDir\": \"<string>\",\n \"templateName\": \"<string>\",\n \"environmentName\": \"<string>\",\n \"environmentCreatorName\": \"<string>\",\n \"environmentCreatorUserId\": \"<string>\",\n \"environmentCreatorEmail\": \"<string>\",\n \"deployerName\": \"<string>\",\n \"deployerUserId\": \"<string>\",\n \"deployerEmail\": \"<string>\",\n \"reviewerName\": \"<string>\",\n \"reviewerEmail\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"prAuthor\": \"<string>\",\n \"prNumber\": \"<string>\",\n \"prSourceRepository\": \"<string>\",\n \"prSourceBranch\": \"<string>\",\n \"prTargetBranch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitUrl\": \"<string>\",\n \"oidcToken\": \"<string>\",\n \"vcsAccessToken\": \"<string>\",\n \"tfPlanJson\": \"<string>\",\n \"cliArgsPlan\": \"<string>\",\n \"cliArgsApply\": \"<string>\",\n \"discoveryRepositoryUrl\": \"<string>\",\n \"discoveryPrNumber\": \"<string>\"\n },\n \"gitUserData\": {\n \"gitUser\": \"<string>\",\n \"gitAvatarUrl\": \"<string>\",\n \"prNumber\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"upstreamEnvironmentId\": \"<string>\",\n \"taskPayload\": \"<string>\",\n \"subEnvironments\": {},\n \"subEnvironmentAlias\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"startedBy": "<string>",
"queuedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"output": {},
"error": {},
"costEstimation": {
"totalMonthlyCost": 123,
"monthlyCostDiff": 123,
"projects": [
{
"diff": {
"totalMonthlyCost": "<string>"
}
}
]
},
"blueprintId": "<string>",
"blueprintName": "<string>",
"blueprintRepository": "<string>",
"blueprintRevision": "<string>",
"blueprintPath": "<string>",
"environmentId": "<string>",
"resourceCount": 123,
"startedByUser": {
"email": "<string>",
"user_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"app_metadata": {
"organizations": [
{
"id": "<string>",
"role": "<string>",
"name": "<string>"
}
],
"isApiKey": true,
"isAutogeneratedTerraformDeployer": true,
"apiKeyType": "<string>",
"createdBy": "<string>",
"organizationId": "<string>",
"isSystemUser": true,
"readOnly": true
},
"picture": "<string>",
"name": "<string>",
"last_login": "<string>",
"given_name": "<string>",
"family_name": "<string>",
"blocked": true
},
"isScheduledRun": true,
"abortedBy": "<string>",
"abortedByUser": {
"email": "<string>",
"user_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"app_metadata": {
"organizations": [
{
"id": "<string>",
"role": "<string>",
"name": "<string>"
}
],
"isApiKey": true,
"isAutogeneratedTerraformDeployer": true,
"apiKeyType": "<string>",
"createdBy": "<string>",
"organizationId": "<string>",
"isSystemUser": true,
"readOnly": true
},
"picture": "<string>",
"name": "<string>",
"last_login": "<string>",
"given_name": "<string>",
"family_name": "<string>",
"blocked": true
},
"reviewersUsers": [
{
"user": {
"email": "<string>",
"user_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"app_metadata": {
"organizations": [
{
"id": "<string>",
"role": "<string>",
"name": "<string>"
}
],
"isApiKey": true,
"isAutogeneratedTerraformDeployer": true,
"apiKeyType": "<string>",
"createdBy": "<string>",
"organizationId": "<string>",
"isSystemUser": true,
"readOnly": true
},
"picture": "<string>",
"name": "<string>",
"last_login": "<string>",
"given_name": "<string>",
"family_name": "<string>",
"blocked": true
}
}
],
"reviewers": [
{
"userId": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"failedCommand": "<string>",
"customEnv0EnvironmentVariables": {
"environmentId": "<string>",
"projectId": "<string>",
"projectName": "<string>",
"parentProjectIds": "<string>",
"parentProjectPath": "<string>",
"deploymentLogId": "<string>",
"deploymentRevision": "<string>",
"workspaceName": "<string>",
"rootDir": "<string>",
"organizationId": "<string>",
"templateId": "<string>",
"templateDir": "<string>",
"templateName": "<string>",
"environmentName": "<string>",
"environmentCreatorName": "<string>",
"environmentCreatorUserId": "<string>",
"environmentCreatorEmail": "<string>",
"deployerName": "<string>",
"deployerUserId": "<string>",
"deployerEmail": "<string>",
"reviewerName": "<string>",
"reviewerEmail": "<string>",
"reviewerUserId": "<string>",
"prAuthor": "<string>",
"prNumber": "<string>",
"prSourceRepository": "<string>",
"prSourceBranch": "<string>",
"prTargetBranch": "<string>",
"commitHash": "<string>",
"commitUrl": "<string>",
"oidcToken": "<string>",
"vcsAccessToken": "<string>",
"tfPlanJson": "<string>",
"cliArgsPlan": "<string>",
"cliArgsApply": "<string>",
"discoveryRepositoryUrl": "<string>",
"discoveryPrNumber": "<string>"
},
"comment": "<string>",
"resources": [
{
"provider": "<string>",
"type": "<string>",
"name": "<string>",
"moduleName": "<string>"
}
],
"gitUser": "<string>",
"gitAvatarUrl": "<string>",
"prNumber": "<string>",
"driftDetected": true,
"plan": {
"resourceChanges": [
{
"name": "<string>",
"providerName": "<string>",
"type": "<string>",
"path": "<string>",
"attributes": [
{
"name": "<string>",
"before": "<unknown>",
"after": "<unknown>"
}
],
"id": "<string>",
"cloudId": "<string>",
"moduleName": "<string>",
"driftByCloud": true,
"importing": {
"id": "<string>"
},
"createBeforeDestroy": true,
"previousAddress": "<string>"
}
],
"outputChanges": [
{
"name": "<string>",
"attributes": [
{
"name": "<string>",
"before": "<unknown>",
"after": "<unknown>"
}
],
"moduleName": "<string>"
}
]
},
"planSummary": {
"added": 123,
"changed": 123,
"destroyed": 123,
"imported": 123
},
"isSkippedApply": true,
"workflowDeploymentId": "<string>",
"workflowFile": {
"environments": {},
"settings": {}
},
"workflowDeploymentOptions": {
"node": "<string>"
},
"stateVersionId": "<string>",
"reviewedBy": "<string>",
"reviewedByUser": {
"email": "<string>",
"user_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"app_metadata": {
"organizations": [
{
"id": "<string>",
"role": "<string>",
"name": "<string>"
}
],
"isApiKey": true,
"isAutogeneratedTerraformDeployer": true,
"apiKeyType": "<string>",
"createdBy": "<string>",
"organizationId": "<string>",
"isSystemUser": true,
"readOnly": true
},
"picture": "<string>",
"name": "<string>",
"last_login": "<string>",
"given_name": "<string>",
"family_name": "<string>",
"blocked": true
},
"targets": [
"<string>"
],
"variables": [
{
"name": "<string>",
"id": "<string>",
"scopeId": "<string>",
"value": "<string>",
"isSensitive": true,
"schema": {
"enum": [
"<string>"
]
},
"userId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"projectId": "<string>"
}
],
"gitMetadata": {
"commit": "<string>",
"branch": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"providerVersions": {},
"moduleVersions": {},
"stateFileHash": {
"value": "<string>"
},
"driftCause": {
"unappliedCommits": [
{
"userEmail": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"commitHash": "<string>"
}
]
}
}Environments
Deploy Environment
POST
/
environments
/
{id}
/
deployments
Deploy Environment
curl --request POST \
--url https://api.env0.com/environments/{id}/deployments \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"workflowDeploymentId": "<string>",
"blueprintId": "<string>",
"blueprintRevision": "<string>",
"blueprintRepository": "<string>",
"configurationChanges": {
"name": "<string>",
"value": "<string>",
"id": "<string>",
"isSensitive": true,
"isReadonly": true,
"isRequired": true,
"regex": "<string>",
"toDelete": true,
"projectId": "<string>",
"schema": {
"enum": [
"<string>"
]
},
"description": "<string>",
"isOutput": true
},
"configurationSetChanges": {
"assign": [
"<string>"
],
"unassign": [
"<string>"
]
},
"envName": "<string>",
"userRequiresApproval": true,
"targets": [
"<string>"
],
"customEnv0EnvironmentVariables": {
"environmentId": "<string>",
"projectId": "<string>",
"projectName": "<string>",
"parentProjectIds": "<string>",
"parentProjectPath": "<string>",
"deploymentLogId": "<string>",
"deploymentRevision": "<string>",
"workspaceName": "<string>",
"rootDir": "<string>",
"organizationId": "<string>",
"templateId": "<string>",
"templateDir": "<string>",
"templateName": "<string>",
"environmentName": "<string>",
"environmentCreatorName": "<string>",
"environmentCreatorUserId": "<string>",
"environmentCreatorEmail": "<string>",
"deployerName": "<string>",
"deployerUserId": "<string>",
"deployerEmail": "<string>",
"reviewerName": "<string>",
"reviewerEmail": "<string>",
"reviewerUserId": "<string>",
"prAuthor": "<string>",
"prNumber": "<string>",
"prSourceRepository": "<string>",
"prSourceBranch": "<string>",
"prTargetBranch": "<string>",
"commitHash": "<string>",
"commitUrl": "<string>",
"oidcToken": "<string>",
"vcsAccessToken": "<string>",
"tfPlanJson": "<string>",
"cliArgsPlan": "<string>",
"cliArgsApply": "<string>",
"discoveryRepositoryUrl": "<string>",
"discoveryPrNumber": "<string>"
},
"gitUserData": {
"gitUser": "<string>",
"gitAvatarUrl": "<string>",
"prNumber": "<string>"
},
"comment": "<string>",
"upstreamEnvironmentId": "<string>",
"taskPayload": "<string>",
"subEnvironments": {},
"subEnvironmentAlias": "<string>"
}
'import requests
url = "https://api.env0.com/environments/{id}/deployments"
payload = {
"workflowDeploymentId": "<string>",
"blueprintId": "<string>",
"blueprintRevision": "<string>",
"blueprintRepository": "<string>",
"configurationChanges": {
"name": "<string>",
"value": "<string>",
"id": "<string>",
"isSensitive": True,
"isReadonly": True,
"isRequired": True,
"regex": "<string>",
"toDelete": True,
"projectId": "<string>",
"schema": { "enum": ["<string>"] },
"description": "<string>",
"isOutput": True
},
"configurationSetChanges": {
"assign": ["<string>"],
"unassign": ["<string>"]
},
"envName": "<string>",
"userRequiresApproval": True,
"targets": ["<string>"],
"customEnv0EnvironmentVariables": {
"environmentId": "<string>",
"projectId": "<string>",
"projectName": "<string>",
"parentProjectIds": "<string>",
"parentProjectPath": "<string>",
"deploymentLogId": "<string>",
"deploymentRevision": "<string>",
"workspaceName": "<string>",
"rootDir": "<string>",
"organizationId": "<string>",
"templateId": "<string>",
"templateDir": "<string>",
"templateName": "<string>",
"environmentName": "<string>",
"environmentCreatorName": "<string>",
"environmentCreatorUserId": "<string>",
"environmentCreatorEmail": "<string>",
"deployerName": "<string>",
"deployerUserId": "<string>",
"deployerEmail": "<string>",
"reviewerName": "<string>",
"reviewerEmail": "<string>",
"reviewerUserId": "<string>",
"prAuthor": "<string>",
"prNumber": "<string>",
"prSourceRepository": "<string>",
"prSourceBranch": "<string>",
"prTargetBranch": "<string>",
"commitHash": "<string>",
"commitUrl": "<string>",
"oidcToken": "<string>",
"vcsAccessToken": "<string>",
"tfPlanJson": "<string>",
"cliArgsPlan": "<string>",
"cliArgsApply": "<string>",
"discoveryRepositoryUrl": "<string>",
"discoveryPrNumber": "<string>"
},
"gitUserData": {
"gitUser": "<string>",
"gitAvatarUrl": "<string>",
"prNumber": "<string>"
},
"comment": "<string>",
"upstreamEnvironmentId": "<string>",
"taskPayload": "<string>",
"subEnvironments": {},
"subEnvironmentAlias": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflowDeploymentId: '<string>',
blueprintId: '<string>',
blueprintRevision: '<string>',
blueprintRepository: '<string>',
configurationChanges: {
name: '<string>',
value: '<string>',
id: '<string>',
isSensitive: true,
isReadonly: true,
isRequired: true,
regex: '<string>',
toDelete: true,
projectId: '<string>',
schema: {enum: ['<string>']},
description: '<string>',
isOutput: true
},
configurationSetChanges: {assign: ['<string>'], unassign: ['<string>']},
envName: '<string>',
userRequiresApproval: true,
targets: ['<string>'],
customEnv0EnvironmentVariables: {
environmentId: '<string>',
projectId: '<string>',
projectName: '<string>',
parentProjectIds: '<string>',
parentProjectPath: '<string>',
deploymentLogId: '<string>',
deploymentRevision: '<string>',
workspaceName: '<string>',
rootDir: '<string>',
organizationId: '<string>',
templateId: '<string>',
templateDir: '<string>',
templateName: '<string>',
environmentName: '<string>',
environmentCreatorName: '<string>',
environmentCreatorUserId: '<string>',
environmentCreatorEmail: '<string>',
deployerName: '<string>',
deployerUserId: '<string>',
deployerEmail: '<string>',
reviewerName: '<string>',
reviewerEmail: '<string>',
reviewerUserId: '<string>',
prAuthor: '<string>',
prNumber: '<string>',
prSourceRepository: '<string>',
prSourceBranch: '<string>',
prTargetBranch: '<string>',
commitHash: '<string>',
commitUrl: '<string>',
oidcToken: '<string>',
vcsAccessToken: '<string>',
tfPlanJson: '<string>',
cliArgsPlan: '<string>',
cliArgsApply: '<string>',
discoveryRepositoryUrl: '<string>',
discoveryPrNumber: '<string>'
},
gitUserData: {gitUser: '<string>', gitAvatarUrl: '<string>', prNumber: '<string>'},
comment: '<string>',
upstreamEnvironmentId: '<string>',
taskPayload: '<string>',
subEnvironments: {},
subEnvironmentAlias: '<string>'
})
};
fetch('https://api.env0.com/environments/{id}/deployments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.env0.com/environments/{id}/deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workflowDeploymentId' => '<string>',
'blueprintId' => '<string>',
'blueprintRevision' => '<string>',
'blueprintRepository' => '<string>',
'configurationChanges' => [
'name' => '<string>',
'value' => '<string>',
'id' => '<string>',
'isSensitive' => true,
'isReadonly' => true,
'isRequired' => true,
'regex' => '<string>',
'toDelete' => true,
'projectId' => '<string>',
'schema' => [
'enum' => [
'<string>'
]
],
'description' => '<string>',
'isOutput' => true
],
'configurationSetChanges' => [
'assign' => [
'<string>'
],
'unassign' => [
'<string>'
]
],
'envName' => '<string>',
'userRequiresApproval' => true,
'targets' => [
'<string>'
],
'customEnv0EnvironmentVariables' => [
'environmentId' => '<string>',
'projectId' => '<string>',
'projectName' => '<string>',
'parentProjectIds' => '<string>',
'parentProjectPath' => '<string>',
'deploymentLogId' => '<string>',
'deploymentRevision' => '<string>',
'workspaceName' => '<string>',
'rootDir' => '<string>',
'organizationId' => '<string>',
'templateId' => '<string>',
'templateDir' => '<string>',
'templateName' => '<string>',
'environmentName' => '<string>',
'environmentCreatorName' => '<string>',
'environmentCreatorUserId' => '<string>',
'environmentCreatorEmail' => '<string>',
'deployerName' => '<string>',
'deployerUserId' => '<string>',
'deployerEmail' => '<string>',
'reviewerName' => '<string>',
'reviewerEmail' => '<string>',
'reviewerUserId' => '<string>',
'prAuthor' => '<string>',
'prNumber' => '<string>',
'prSourceRepository' => '<string>',
'prSourceBranch' => '<string>',
'prTargetBranch' => '<string>',
'commitHash' => '<string>',
'commitUrl' => '<string>',
'oidcToken' => '<string>',
'vcsAccessToken' => '<string>',
'tfPlanJson' => '<string>',
'cliArgsPlan' => '<string>',
'cliArgsApply' => '<string>',
'discoveryRepositoryUrl' => '<string>',
'discoveryPrNumber' => '<string>'
],
'gitUserData' => [
'gitUser' => '<string>',
'gitAvatarUrl' => '<string>',
'prNumber' => '<string>'
],
'comment' => '<string>',
'upstreamEnvironmentId' => '<string>',
'taskPayload' => '<string>',
'subEnvironments' => [
],
'subEnvironmentAlias' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.env0.com/environments/{id}/deployments"
payload := strings.NewReader("{\n \"workflowDeploymentId\": \"<string>\",\n \"blueprintId\": \"<string>\",\n \"blueprintRevision\": \"<string>\",\n \"blueprintRepository\": \"<string>\",\n \"configurationChanges\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"isSensitive\": true,\n \"isReadonly\": true,\n \"isRequired\": true,\n \"regex\": \"<string>\",\n \"toDelete\": true,\n \"projectId\": \"<string>\",\n \"schema\": {\n \"enum\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"isOutput\": true\n },\n \"configurationSetChanges\": {\n \"assign\": [\n \"<string>\"\n ],\n \"unassign\": [\n \"<string>\"\n ]\n },\n \"envName\": \"<string>\",\n \"userRequiresApproval\": true,\n \"targets\": [\n \"<string>\"\n ],\n \"customEnv0EnvironmentVariables\": {\n \"environmentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"projectName\": \"<string>\",\n \"parentProjectIds\": \"<string>\",\n \"parentProjectPath\": \"<string>\",\n \"deploymentLogId\": \"<string>\",\n \"deploymentRevision\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"rootDir\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateDir\": \"<string>\",\n \"templateName\": \"<string>\",\n \"environmentName\": \"<string>\",\n \"environmentCreatorName\": \"<string>\",\n \"environmentCreatorUserId\": \"<string>\",\n \"environmentCreatorEmail\": \"<string>\",\n \"deployerName\": \"<string>\",\n \"deployerUserId\": \"<string>\",\n \"deployerEmail\": \"<string>\",\n \"reviewerName\": \"<string>\",\n \"reviewerEmail\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"prAuthor\": \"<string>\",\n \"prNumber\": \"<string>\",\n \"prSourceRepository\": \"<string>\",\n \"prSourceBranch\": \"<string>\",\n \"prTargetBranch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitUrl\": \"<string>\",\n \"oidcToken\": \"<string>\",\n \"vcsAccessToken\": \"<string>\",\n \"tfPlanJson\": \"<string>\",\n \"cliArgsPlan\": \"<string>\",\n \"cliArgsApply\": \"<string>\",\n \"discoveryRepositoryUrl\": \"<string>\",\n \"discoveryPrNumber\": \"<string>\"\n },\n \"gitUserData\": {\n \"gitUser\": \"<string>\",\n \"gitAvatarUrl\": \"<string>\",\n \"prNumber\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"upstreamEnvironmentId\": \"<string>\",\n \"taskPayload\": \"<string>\",\n \"subEnvironments\": {},\n \"subEnvironmentAlias\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.env0.com/environments/{id}/deployments")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"workflowDeploymentId\": \"<string>\",\n \"blueprintId\": \"<string>\",\n \"blueprintRevision\": \"<string>\",\n \"blueprintRepository\": \"<string>\",\n \"configurationChanges\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"isSensitive\": true,\n \"isReadonly\": true,\n \"isRequired\": true,\n \"regex\": \"<string>\",\n \"toDelete\": true,\n \"projectId\": \"<string>\",\n \"schema\": {\n \"enum\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"isOutput\": true\n },\n \"configurationSetChanges\": {\n \"assign\": [\n \"<string>\"\n ],\n \"unassign\": [\n \"<string>\"\n ]\n },\n \"envName\": \"<string>\",\n \"userRequiresApproval\": true,\n \"targets\": [\n \"<string>\"\n ],\n \"customEnv0EnvironmentVariables\": {\n \"environmentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"projectName\": \"<string>\",\n \"parentProjectIds\": \"<string>\",\n \"parentProjectPath\": \"<string>\",\n \"deploymentLogId\": \"<string>\",\n \"deploymentRevision\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"rootDir\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateDir\": \"<string>\",\n \"templateName\": \"<string>\",\n \"environmentName\": \"<string>\",\n \"environmentCreatorName\": \"<string>\",\n \"environmentCreatorUserId\": \"<string>\",\n \"environmentCreatorEmail\": \"<string>\",\n \"deployerName\": \"<string>\",\n \"deployerUserId\": \"<string>\",\n \"deployerEmail\": \"<string>\",\n \"reviewerName\": \"<string>\",\n \"reviewerEmail\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"prAuthor\": \"<string>\",\n \"prNumber\": \"<string>\",\n \"prSourceRepository\": \"<string>\",\n \"prSourceBranch\": \"<string>\",\n \"prTargetBranch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitUrl\": \"<string>\",\n \"oidcToken\": \"<string>\",\n \"vcsAccessToken\": \"<string>\",\n \"tfPlanJson\": \"<string>\",\n \"cliArgsPlan\": \"<string>\",\n \"cliArgsApply\": \"<string>\",\n \"discoveryRepositoryUrl\": \"<string>\",\n \"discoveryPrNumber\": \"<string>\"\n },\n \"gitUserData\": {\n \"gitUser\": \"<string>\",\n \"gitAvatarUrl\": \"<string>\",\n \"prNumber\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"upstreamEnvironmentId\": \"<string>\",\n \"taskPayload\": \"<string>\",\n \"subEnvironments\": {},\n \"subEnvironmentAlias\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.env0.com/environments/{id}/deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflowDeploymentId\": \"<string>\",\n \"blueprintId\": \"<string>\",\n \"blueprintRevision\": \"<string>\",\n \"blueprintRepository\": \"<string>\",\n \"configurationChanges\": {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<string>\",\n \"isSensitive\": true,\n \"isReadonly\": true,\n \"isRequired\": true,\n \"regex\": \"<string>\",\n \"toDelete\": true,\n \"projectId\": \"<string>\",\n \"schema\": {\n \"enum\": [\n \"<string>\"\n ]\n },\n \"description\": \"<string>\",\n \"isOutput\": true\n },\n \"configurationSetChanges\": {\n \"assign\": [\n \"<string>\"\n ],\n \"unassign\": [\n \"<string>\"\n ]\n },\n \"envName\": \"<string>\",\n \"userRequiresApproval\": true,\n \"targets\": [\n \"<string>\"\n ],\n \"customEnv0EnvironmentVariables\": {\n \"environmentId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"projectName\": \"<string>\",\n \"parentProjectIds\": \"<string>\",\n \"parentProjectPath\": \"<string>\",\n \"deploymentLogId\": \"<string>\",\n \"deploymentRevision\": \"<string>\",\n \"workspaceName\": \"<string>\",\n \"rootDir\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"templateDir\": \"<string>\",\n \"templateName\": \"<string>\",\n \"environmentName\": \"<string>\",\n \"environmentCreatorName\": \"<string>\",\n \"environmentCreatorUserId\": \"<string>\",\n \"environmentCreatorEmail\": \"<string>\",\n \"deployerName\": \"<string>\",\n \"deployerUserId\": \"<string>\",\n \"deployerEmail\": \"<string>\",\n \"reviewerName\": \"<string>\",\n \"reviewerEmail\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"prAuthor\": \"<string>\",\n \"prNumber\": \"<string>\",\n \"prSourceRepository\": \"<string>\",\n \"prSourceBranch\": \"<string>\",\n \"prTargetBranch\": \"<string>\",\n \"commitHash\": \"<string>\",\n \"commitUrl\": \"<string>\",\n \"oidcToken\": \"<string>\",\n \"vcsAccessToken\": \"<string>\",\n \"tfPlanJson\": \"<string>\",\n \"cliArgsPlan\": \"<string>\",\n \"cliArgsApply\": \"<string>\",\n \"discoveryRepositoryUrl\": \"<string>\",\n \"discoveryPrNumber\": \"<string>\"\n },\n \"gitUserData\": {\n \"gitUser\": \"<string>\",\n \"gitAvatarUrl\": \"<string>\",\n \"prNumber\": \"<string>\"\n },\n \"comment\": \"<string>\",\n \"upstreamEnvironmentId\": \"<string>\",\n \"taskPayload\": \"<string>\",\n \"subEnvironments\": {},\n \"subEnvironmentAlias\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"startedBy": "<string>",
"queuedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"output": {},
"error": {},
"costEstimation": {
"totalMonthlyCost": 123,
"monthlyCostDiff": 123,
"projects": [
{
"diff": {
"totalMonthlyCost": "<string>"
}
}
]
},
"blueprintId": "<string>",
"blueprintName": "<string>",
"blueprintRepository": "<string>",
"blueprintRevision": "<string>",
"blueprintPath": "<string>",
"environmentId": "<string>",
"resourceCount": 123,
"startedByUser": {
"email": "<string>",
"user_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"app_metadata": {
"organizations": [
{
"id": "<string>",
"role": "<string>",
"name": "<string>"
}
],
"isApiKey": true,
"isAutogeneratedTerraformDeployer": true,
"apiKeyType": "<string>",
"createdBy": "<string>",
"organizationId": "<string>",
"isSystemUser": true,
"readOnly": true
},
"picture": "<string>",
"name": "<string>",
"last_login": "<string>",
"given_name": "<string>",
"family_name": "<string>",
"blocked": true
},
"isScheduledRun": true,
"abortedBy": "<string>",
"abortedByUser": {
"email": "<string>",
"user_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"app_metadata": {
"organizations": [
{
"id": "<string>",
"role": "<string>",
"name": "<string>"
}
],
"isApiKey": true,
"isAutogeneratedTerraformDeployer": true,
"apiKeyType": "<string>",
"createdBy": "<string>",
"organizationId": "<string>",
"isSystemUser": true,
"readOnly": true
},
"picture": "<string>",
"name": "<string>",
"last_login": "<string>",
"given_name": "<string>",
"family_name": "<string>",
"blocked": true
},
"reviewersUsers": [
{
"user": {
"email": "<string>",
"user_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"app_metadata": {
"organizations": [
{
"id": "<string>",
"role": "<string>",
"name": "<string>"
}
],
"isApiKey": true,
"isAutogeneratedTerraformDeployer": true,
"apiKeyType": "<string>",
"createdBy": "<string>",
"organizationId": "<string>",
"isSystemUser": true,
"readOnly": true
},
"picture": "<string>",
"name": "<string>",
"last_login": "<string>",
"given_name": "<string>",
"family_name": "<string>",
"blocked": true
}
}
],
"reviewers": [
{
"userId": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"failedCommand": "<string>",
"customEnv0EnvironmentVariables": {
"environmentId": "<string>",
"projectId": "<string>",
"projectName": "<string>",
"parentProjectIds": "<string>",
"parentProjectPath": "<string>",
"deploymentLogId": "<string>",
"deploymentRevision": "<string>",
"workspaceName": "<string>",
"rootDir": "<string>",
"organizationId": "<string>",
"templateId": "<string>",
"templateDir": "<string>",
"templateName": "<string>",
"environmentName": "<string>",
"environmentCreatorName": "<string>",
"environmentCreatorUserId": "<string>",
"environmentCreatorEmail": "<string>",
"deployerName": "<string>",
"deployerUserId": "<string>",
"deployerEmail": "<string>",
"reviewerName": "<string>",
"reviewerEmail": "<string>",
"reviewerUserId": "<string>",
"prAuthor": "<string>",
"prNumber": "<string>",
"prSourceRepository": "<string>",
"prSourceBranch": "<string>",
"prTargetBranch": "<string>",
"commitHash": "<string>",
"commitUrl": "<string>",
"oidcToken": "<string>",
"vcsAccessToken": "<string>",
"tfPlanJson": "<string>",
"cliArgsPlan": "<string>",
"cliArgsApply": "<string>",
"discoveryRepositoryUrl": "<string>",
"discoveryPrNumber": "<string>"
},
"comment": "<string>",
"resources": [
{
"provider": "<string>",
"type": "<string>",
"name": "<string>",
"moduleName": "<string>"
}
],
"gitUser": "<string>",
"gitAvatarUrl": "<string>",
"prNumber": "<string>",
"driftDetected": true,
"plan": {
"resourceChanges": [
{
"name": "<string>",
"providerName": "<string>",
"type": "<string>",
"path": "<string>",
"attributes": [
{
"name": "<string>",
"before": "<unknown>",
"after": "<unknown>"
}
],
"id": "<string>",
"cloudId": "<string>",
"moduleName": "<string>",
"driftByCloud": true,
"importing": {
"id": "<string>"
},
"createBeforeDestroy": true,
"previousAddress": "<string>"
}
],
"outputChanges": [
{
"name": "<string>",
"attributes": [
{
"name": "<string>",
"before": "<unknown>",
"after": "<unknown>"
}
],
"moduleName": "<string>"
}
]
},
"planSummary": {
"added": 123,
"changed": 123,
"destroyed": 123,
"imported": 123
},
"isSkippedApply": true,
"workflowDeploymentId": "<string>",
"workflowFile": {
"environments": {},
"settings": {}
},
"workflowDeploymentOptions": {
"node": "<string>"
},
"stateVersionId": "<string>",
"reviewedBy": "<string>",
"reviewedByUser": {
"email": "<string>",
"user_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"app_metadata": {
"organizations": [
{
"id": "<string>",
"role": "<string>",
"name": "<string>"
}
],
"isApiKey": true,
"isAutogeneratedTerraformDeployer": true,
"apiKeyType": "<string>",
"createdBy": "<string>",
"organizationId": "<string>",
"isSystemUser": true,
"readOnly": true
},
"picture": "<string>",
"name": "<string>",
"last_login": "<string>",
"given_name": "<string>",
"family_name": "<string>",
"blocked": true
},
"targets": [
"<string>"
],
"variables": [
{
"name": "<string>",
"id": "<string>",
"scopeId": "<string>",
"value": "<string>",
"isSensitive": true,
"schema": {
"enum": [
"<string>"
]
},
"userId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"projectId": "<string>"
}
],
"gitMetadata": {
"commit": "<string>",
"branch": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"providerVersions": {},
"moduleVersions": {},
"stateFileHash": {
"value": "<string>"
},
"driftCause": {
"unappliedCommits": [
{
"userEmail": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"commitHash": "<string>"
}
]
}
}Authorizations
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.
Path Parameters
Body
application/json
Available options:
deploy, prPlan, driftDetection, task, remotePlan, dryRun, moduleTest Manage variables in the environment. Either a single variable or an array of variables.
- object
- object[]
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
triggerName
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>Option 5 · enum<string>Option 6 · enum<string>
Available options:
user, terraform-cli, workflow, user, terraform-cli, workflow, user, terraform-cli, workflow Show child attributes
Show child attributes
Available options:
DISABLED, CODE_TO_CLOUD, CLOUD_TO_CODE, SMART_REMEDIATION, DISABLED, CODE_TO_CLOUD, CLOUD_TO_CODE, SMART_REMEDIATION [Optional] Only applicable when running a Workflow Environment. Allows to run a partial Workflow, starting from a specific point in the pipeline. Or run a single sub-environment deploy/destroy.
Show child attributes
Show child attributes
Response
200 - application/json
Available options:
deploy, destroy, prPlan, driftDetection, task, remotePlan, dryRun, moduleTest, deploy, destroy, prPlan, driftDetection, task, remotePlan, dryRun, moduleTest - Option 1 · object
- Option 2 · object[]
- Option 3 · object
- Option 4 · object[]
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 blueprintType
Option 1 · enum<string>Option 2 · stringOption 3 · stringOption 4 · enum<string>Option 5 · stringOption 6 · 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, opentofu, terraform, terragrunt, pulumi, k8s, cloudformation, helm, ansible Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
triggerName
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>Option 5 · enum<string>Option 6 · enum<string>
Available options:
user, terraform-cli, workflow, user, terraform-cli, workflow, user, terraform-cli, workflow Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I