Update Organization

curl --request PUT \
  --url https://api.env0.com/organizations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "photoUrl": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.env0.com/organizations/{id}"

payload = {
    "name": "<string>",
    "photoUrl": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', photoUrl: '<string>', description: '<string>'})
};

fetch('https://api.env0.com/organizations/{id}', 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/organizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'photoUrl' => '<string>',
    'description' => '<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/organizations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.env0.com/organizations/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.env0.com/organizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "projectCustomFlowsPolicy": "MERGE_WITH_TEMPLATES",
  "id": "<string>",
  "name": "<string>",
  "createdBy": "<string>",
  "mode": "paying",
  "role": "<string>",
  "maxTtl": "<string>",
  "defaultTtl": "<string>",
  "doNotReportSkippedStatusChecks": true,
  "doNotConsiderMergeCommitsForPrPlans": true,
  "enableOidc": true,
  "enforcePrCommenterPermissions": true,
  "requireVerifiedVcsUserIds": true,
  "notifyAdminsOnVcsUserIdChange": true,
  "repositoryCustomFlowsPolicy": "ALLOW",
  "allowEnv0Secrets": true,
  "requireApprovalForPrApplies": true,
  "disablePrComments": true,
  "allowMergeableBypassForPrApply": true,
  "ipAllowlist": [
    {
      "type": "address",
      "address": "<string>",
      "network": "<string>",
      "prefix": 123,
      "start": "<string>",
      "end": "<string>",
      "family": "ipv4"
    }
  ],
  "codingAgentEnabled": true,
  "codingAgentTermsVersion": "<string>",
  "description": "<string>",
  "photoUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "trialEnd": "2023-11-07T05:31:56Z",
  "codingAgentConsent": {
    "userId": "<string>",
    "acceptedAt": "<string>",
    "termsVersion": "<string>"
  },
  "isSelfHostedK8s": true
}

PUT

organizations

{id}

Update Organization

curl --request PUT \
  --url https://api.env0.com/organizations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "photoUrl": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.env0.com/organizations/{id}"

payload = {
    "name": "<string>",
    "photoUrl": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', photoUrl: '<string>', description: '<string>'})
};

fetch('https://api.env0.com/organizations/{id}', 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/organizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'photoUrl' => '<string>',
    'description' => '<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/organizations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.env0.com/organizations/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.env0.com/organizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"photoUrl\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "projectCustomFlowsPolicy": "MERGE_WITH_TEMPLATES",
  "id": "<string>",
  "name": "<string>",
  "createdBy": "<string>",
  "mode": "paying",
  "role": "<string>",
  "maxTtl": "<string>",
  "defaultTtl": "<string>",
  "doNotReportSkippedStatusChecks": true,
  "doNotConsiderMergeCommitsForPrPlans": true,
  "enableOidc": true,
  "enforcePrCommenterPermissions": true,
  "requireVerifiedVcsUserIds": true,
  "notifyAdminsOnVcsUserIdChange": true,
  "repositoryCustomFlowsPolicy": "ALLOW",
  "allowEnv0Secrets": true,
  "requireApprovalForPrApplies": true,
  "disablePrComments": true,
  "allowMergeableBypassForPrApply": true,
  "ipAllowlist": [
    {
      "type": "address",
      "address": "<string>",
      "network": "<string>",
      "prefix": 123,
      "start": "<string>",
      "end": "<string>",
      "family": "ipv4"
    }
  ],
  "codingAgentEnabled": true,
  "codingAgentTermsVersion": "<string>",
  "description": "<string>",
  "photoUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "trialEnd": "2023-11-07T05:31:56Z",
  "codingAgentConsent": {
    "userId": "<string>",
    "acceptedAt": "<string>",
    "termsVersion": "<string>"
  },
  "isSelfHostedK8s": true
}

Authorizations

Authorization

string

header

required

env zero 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 env zero 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

env zero 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

string

required

Body

application/json

name

string

required

photoUrl

string

description

string

Response

200 - application/json

projectCustomFlowsPolicy

enum<string>

required

Available options:

MERGE_WITH_TEMPLATES,

OVERRIDE_TEMPLATES,

MERGE_WITH_TEMPLATES,

OVERRIDE_TEMPLATES

string

required

name

string

required

createdBy

string

required

mode

enum<string>

required

Available options:

paying,

free,

paying,

free

role

string

required

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

Pattern: ^\d+-[h|d|w|M]|inherit

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

Pattern: ^\d+-[h|d|w|M]|inherit

doNotReportSkippedStatusChecks

boolean

doNotConsiderMergeCommitsForPrPlans

boolean

enableOidc

boolean

enforcePrCommenterPermissions

boolean

requireVerifiedVcsUserIds

boolean

When true, a PR comment command runs only for a commenter who connected their VCS account in env0, and a typed VCS user ID is ignored. Applies to the VCS providers that support connecting (GitHub, GitLab and Azure DevOps today)

notifyAdminsOnVcsUserIdChange

boolean

Email the organization admins when a user sets, changes or removes a VCS user ID. Undefined means on.

repositoryCustomFlowsPolicy

enum<string>

Whether env0.yml files in a template's repository run. ALLOW runs them. VERIFIED_USERS runs a pull request's env0.yml only when the pusher is a verified VCS user with the Run Custom Flow permission on the environment, and otherwise runs the tracked branch's env0.yml. env0 identifies the pusher on GitHub, GitLab and Bitbucket Cloud only, so on other VCS providers a pull request that changes env0.yml runs the tracked branch's env0.yml. A deployment of a revision whose env0.yml differs from the tracked one also needs the Run Custom Flow permission. BLOCK never runs them, so only custom flows assigned in env0 run. VERIFIED_USERS and BLOCK take effect only for organizations where repository custom flow controls are enabled by env0. Undefined means ALLOW

Available options:

ALLOW,

VERIFIED_USERS,

BLOCK,

ALLOW,

VERIFIED_USERS,

BLOCK

allowEnv0Secrets

boolean

requireApprovalForPrApplies

boolean

disablePrComments

boolean

allowMergeableBypassForPrApply

boolean

ipAllowlist

object[]

IP allowlist rules. When non-empty, only requests from matching IPs are allowed for the organization (both UI/SSO logins and agent API). Empty or undefined means open by default.

Show child attributes

codingAgentEnabled

boolean

Whether env0 runs the AI coding agent for this organization's drift fixes. Turning it on requires codingAgentTermsVersion, unless the organization already accepted the current terms

codingAgentTermsVersion

string

Request only, never returned. The version of the coding agent terms the caller accepts. Required, as the current version, when codingAgentEnabled turns the agent on under terms the organization has not accepted

description

string

photoUrl

string

createdAt

string<date-time>

updatedAt

string<date-time>

trialEnd

string<date-time>

Read-only. The last acceptance of the coding agent terms, kept when the coding agent is turned off

Show child attributes

isSelfHostedK8s

boolean

Users

Agents Settings

Audit Events

Templates

Modules

Custom Flow

Approval Policy

Bulk Operations

Cloud Compass

Code-Optimizer (BETA)

Configuration

Cost

Credentials

Dashboard

Deployment Logs

Drift

Environment Import

Environment Outputs

Environments

Projects

Notifications

Organization

Provider Registry

Remote Backend

Roles

Scheduling

Teams

VCS

Role Based Access

Webhooks

Update Organization

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

Path Parameters

Body

Response