Get a Cloud Compass credential wizard draft

curl --request GET \
  --url https://api.env0.com/cloud-compass/drafts/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.env0.com/cloud-compass/drafts/{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/cloud-compass/drafts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.env0.com/cloud-compass/drafts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.env0.com/cloud-compass/drafts/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "draftId": "<string>",
  "organizationId": "<string>",
  "accountMode": "single",
  "setupMethod": "guided",
  "signInMethod": "assume_role",
  "includeCostData": true,
  "draftStatus": "waiting",
  "createdAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "oidcTrust": {
    "issuerUrl": "<string>",
    "audience": "<string>",
    "subject": "<string>"
  },
  "failureReason": "stack_rolled_back",
  "stackOutputs": {
    "roleArn": "<string>",
    "awsAccountId": "<string>",
    "awsOrganizationId": "<string>",
    "organizationLookupFailed": true,
    "curExportName": "<string>",
    "curBucket": "<string>",
    "curPrefix": "<string>"
  },
  "testResults": [
    {
      "feature": "asset_inventory",
      "status": "created",
      "failureReason": "<string>",
      "failureCode": "<string>"
    }
  ],
  "organizationUnitIds": [
    "<string>"
  ],
  "skipAccountIds": [
    "<string>"
  ],
  "setupId": "<string>",
  "autoCreating": true,
  "credential": {
    "credentialId": "<string>",
    "status": "CREATING",
    "syncs": [
      {
        "syncName": "<string>",
        "feature": "<string>"
      }
    ]
  }
}

GET

cloud-compass

drafts

{id}

Get a Cloud Compass credential wizard draft

curl --request GET \
  --url https://api.env0.com/cloud-compass/drafts/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.env0.com/cloud-compass/drafts/{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/cloud-compass/drafts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.env0.com/cloud-compass/drafts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.env0.com/cloud-compass/drafts/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "draftId": "<string>",
  "organizationId": "<string>",
  "accountMode": "single",
  "setupMethod": "guided",
  "signInMethod": "assume_role",
  "includeCostData": true,
  "draftStatus": "waiting",
  "createdAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "oidcTrust": {
    "issuerUrl": "<string>",
    "audience": "<string>",
    "subject": "<string>"
  },
  "failureReason": "stack_rolled_back",
  "stackOutputs": {
    "roleArn": "<string>",
    "awsAccountId": "<string>",
    "awsOrganizationId": "<string>",
    "organizationLookupFailed": true,
    "curExportName": "<string>",
    "curBucket": "<string>",
    "curPrefix": "<string>"
  },
  "testResults": [
    {
      "feature": "asset_inventory",
      "status": "created",
      "failureReason": "<string>",
      "failureCode": "<string>"
    }
  ],
  "organizationUnitIds": [
    "<string>"
  ],
  "skipAccountIds": [
    "<string>"
  ],
  "setupId": "<string>",
  "autoCreating": true,
  "credential": {
    "credentialId": "<string>",
    "status": "CREATING",
    "syncs": [
      {
        "syncName": "<string>",
        "feature": "<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

string

required

Query Parameters

organizationId

string

required

Response

200 - application/json

draftId

string

required

organizationId

string

required

accountMode

enum<string>

required

Available options:

single,

organization

setupMethod

enum<string>

required

Only POST aws-access-setups makes an environment draft, whose read role an env zero environment deploys.

Available options:

guided,

manual,

environment

How CloudQuery signs in to the read role. A draft or credential from before OIDC (ATL-606) has none: assume_role.

Available options:

assume_role,

oidc

includeCostData

boolean

required

False: the stack creates no CUR export and the credential gets no cost sync.

draftStatus

enum<string>

required

Available options:

waiting,

stack_done,

verifying,

verified,

failed

createdAt

string<date-time>

required

externalId

string

Assume role only.

oidcTrust

object

OIDC only.

Show child attributes

failureReason

enum<string>

Available options:

stack_rolled_back,

callback_timeout,

test_connection_failed,

test_connection_timeout

stackOutputs

object

Show child attributes

testResults

object[]

The CloudQuery test connection result per feature, once verify has started.

Show child attributes

organizationUnitIds

string[]

Organization mode: the OUs the last verify tested. Empty means the whole Organization.

Pattern: ^(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}|r-[0-9a-z]{4,32})$

skipAccountIds

string[]

Organization mode: the member accounts the last verify skipped.

Pattern: ^\d{12}$

setupId

string

Environment only: the AWS access setup whose environment makes the draft's role.

autoCreating

boolean

Environment only: true while env zero verifies the draft and creates its credential after the setup applied, so a client shows them rather than verifying and creating. False once it stops; a failed verify keeps its results.

credential

object

The credential the draft created, or is creating. Only the draft read returns it.

Show child attributes

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

Get a Cloud Compass credential wizard draft

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

Query Parameters

Response