Enable/Update Environment Discovery Configuration

PUT /environment-discovery/projects/{projectId}

Enable/Update Environment Discovery Configuration

cURL

curl --request PUT \
  --url https://api.env0.com/environment-discovery/projects/{projectId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "projectId": "<string>",
  "organizationId": "<string>",
  "tokenName": "<string>",
  "tokenId": "<string>",
  "sshKeys": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "githubInstallationId": 123,
  "bitbucketClientKey": "<string>",
  "isBitbucketServer": true,
  "isGitLabEnterprise": true,
  "isGitHubEnterprise": true,
  "isGitLab": true,
  "isAzureDevOps": true,
  "isHelmRepository": true,
  "vcsConnectionId": "<string>",
  "repository": "<string>",
  "revision": "<string>",
  "path": "<string>",
  "fileName": "<string>",
  "helmChartName": "<string>",
  "terraformVersion": "<string>",
  "opentofuVersion": "<string>",
  "terragruntVersion": "<string>",
  "pulumiVersion": "<string>",
  "ansibleVersion": "<string>",
  "globPattern": "<string>",
  "rootPath": "<string>",
  "autoDeployByCustomGlob": "<string>",
  "createNewEnvironmentsFromPullRequests": true,
  "isTerragruntRunAll": true
}
'

200

{
  "repository": "<string>",
  "type": "opentofu",
  "organizationId": "<string>",
  "name": "<string>",
  "discoveryFileConfiguration": {
    "repositoryRegex": "<string>"
  },
  "globPattern": "<string>",
  "environmentPlacement": "topProject",
  "rootPath": "<string>",
  "workspaceNaming": "default",
  "autoDeployByCustomGlob": "<string>",
  "createNewEnvironmentsFromPullRequests": true,
  "isTerragruntRunAll": true,
  "revision": "<string>",
  "path": "<string>",
  "fileName": "<string>",
  "helmChartName": "<string>",
  "terraformVersion": "<string>",
  "opentofuVersion": "<string>",
  "terragruntVersion": "<string>",
  "terragruntTfBinary": "terraform",
  "pulumiVersion": "<string>",
  "ansibleVersion": "<string>",
  "tokenName": "<string>",
  "tokenId": "<string>",
  "sshKeys": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "githubInstallationId": 123,
  "bitbucketClientKey": "<string>",
  "isBitbucketServer": true,
  "isGitLabEnterprise": true,
  "isGitHubEnterprise": true,
  "isGitLab": true,
  "isAzureDevOps": true,
  "isHelmRepository": true,
  "vcsConnectionId": "<string>",
  "id": "<string>",
  "projectId": "<string>",
  "author": {
    "email": "<string>",
    "user_id": "<string>",
    "username": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "app_metadata": {
      "organizations": [
        {
          "id": "<string>",
          "role": "<string>",
          "name": "<string>"
        }
      ],
      "isApiKey": true,
      "isAutogeneratedTerraformDeployer": true,
      "apiKeyType": "oidc",
      "createdBy": "<string>",
      "organizationId": "<string>",
      "isSystemUser": true,
      "readOnly": true,
      "blockedByOrganizationLockout": true
    },
    "picture": "<string>",
    "name": "<string>",
    "last_login": "<string>",
    "given_name": "<string>",
    "family_name": "<string>",
    "blocked": true,
    "identities": [
      {
        "provider": "<string>",
        "connection": "<string>",
        "user_id": "<string>",
        "isSocial": true,
        "access_token": "<string>",
        "refresh_token": "<string>"
      }
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isDeleted": true,
  "authorId": "<string>",
  "isSingleUse": true,
  "description": "<string>",
  "retry": {
    "onDestroy": {
      "times": 123,
      "errorRegex": "<string>"
    },
    "onDeploy": {
      "times": 123,
      "errorRegex": "<string>"
    }
  },
  "runTestsOnPullRequest": true,
  "projectIds": [
    "<string>"
  ],
  "isAllProjects": true,
  "tagPrefix": "<string>"
}

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

projectId · string · required

The Project ID to enable environment discovery for

Body

application/json

id · string

projectId · string

organizationId · string

tokenName · string

tokenId · string

sshKeys · object[]

Show child attributes

githubInstallationId · number | null

bitbucketClientKey · string | null

isBitbucketServer · boolean

isGitLabEnterprise · boolean

isGitHubEnterprise · boolean

isGitLab · boolean

isAzureDevOps · boolean

isHelmRepository · boolean

vcsConnectionId · string | null

repository · string

revision · string

path · string

fileName · string

helmChartName · string

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.

opentofuVersion · string

terragruntVersion · string

terragruntTfBinary · enum<string>

Available options: terraform, opentofu, terraform, opentofu, terraform, opentofu

pulumiVersion · string

ansibleVersion · string

type · Option 1 · enum<string> Option 2 · string Option 3 · string Option 4 · string Option 5 · string Option 6 · string Option 7 · string Option 8 · enum<string> Option 9 · string Option 10 · string Option 11 · string Option 12 · string Option 13 · string Option 14 · string Option 15 · enum<string> Option 16 · string Option 17 · string Option 18 · string Option 19 · string Option 20 · string Option 21 · string Option 22 · enum<string> Option 23 · string Option 24 · string Option 25 · string Option 26 · string Option 27 · string Option 28 · string Option 29 · enum<string> Option 30 · string Option 31 · string Option 32 · string Option 33 · string Option 34 · string Option 35 · 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, opentofu, terraform, terragrunt, pulumi, k8s, cloudformation, helm, ansible, opentofu, terraform, terragrunt, pulumi, k8s, cloudformation, helm, ansible

globPattern · string

environmentPlacement · enum<string>

Available options: topProject, existingSubProject

rootPath · string

workspaceNaming · enum<string>

Available options: default, environmentName

autoDeployByCustomGlob · string | null

createNewEnvironmentsFromPullRequests · boolean

isTerragruntRunAll · boolean

discoveryFileConfiguration · object

Show child attributes

Response

200 - application/json

repository · string · required

type · Option 1 · enum<string> Option 2 · string Option 3 · string Option 4 · string Option 5 · string Option 6 · string Option 7 · string Option 8 · enum<string> Option 9 · string Option 10 · string Option 11 · string Option 12 · string Option 13 · string Option 14 · string Option 15 · enum<string> Option 16 · string Option 17 · string Option 18 · string Option 19 · string Option 20 · string Option 21 · string Option 22 · enum<string> Option 23 · string Option 24 · string Option 25 · string Option 26 · string Option 27 · string Option 28 · string Option 29 · enum<string> Option 30 · string Option 31 · string Option 32 · string Option 33 · string Option 34 · string Option 35 · 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, opentofu, terraform, terragrunt, pulumi, k8s, cloudformation, helm, ansible

organizationId · string · required

name · string · required

discoveryFileConfiguration · object

Show child attributes

globPattern · string

environmentPlacement · enum<string>

Available options: topProject, existingSubProject

rootPath · string

workspaceNaming · enum<string>

Available options: default, environmentName

autoDeployByCustomGlob · string | null

createNewEnvironmentsFromPullRequests · boolean

isTerragruntRunAll · boolean

revision · string

path · string

fileName · string

helmChartName · string

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.

opentofuVersion · string

terragruntVersion · string

terragruntTfBinary · enum<string>

Available options: terraform, opentofu, terraform, opentofu, terraform, opentofu

pulumiVersion · string

ansibleVersion · string

tokenName · string

tokenId · string

sshKeys · object[]

Show child attributes

githubInstallationId · number | null

bitbucketClientKey · string | null

isBitbucketServer · boolean

isGitLabEnterprise · boolean

isGitHubEnterprise · boolean

isGitLab · boolean

isAzureDevOps · boolean

isHelmRepository · boolean

vcsConnectionId · string | null

id · string

projectId · string

author · object

Show child attributes

createdAt · string<date-time>

updatedAt · string<date-time>

isDeleted · boolean

authorId · string

isSingleUse · boolean

description · string

retry · object

Show child attributes

runTestsOnPullRequest · boolean

projectIds · string[]

isAllProjects · boolean

When true, the template is available in all the organization's projects, including projects created in the future. Ignores projectIds.

tagPrefix · string