Find Cloud Resources
curl --request POST \
--url https://api.env0.com/cloud/resources \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"organizationId": "<string>",
"filters": {
"cloudConfigurationId": {
"eq": "<string>",
"in": [
"<string>"
]
},
"cloudProvider": {
"eq": "<string>",
"in": [
"<string>"
]
},
"managementType": {
"eq": "<string>",
"in": [
"<string>"
]
},
"region": {
"eq": "<string>",
"in": [
"<string>"
]
},
"type": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"name": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"accountId": {
"eq": "<string>",
"in": [
"<string>"
]
},
"service": {
"eq": "<string>",
"in": [
"<string>"
]
},
"resourceId": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"cloudId": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"searchBy": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"driftStatus": {
"eq": "<string>",
"in": [
"<string>"
]
},
"environmentId": {
"eq": "<string>",
"in": [
"<string>"
]
}
},
"orderBy": [
[
"<unknown>"
]
]
}
'import requests
url = "https://api.env0.com/cloud/resources"
payload = {
"organizationId": "<string>",
"filters": {
"cloudConfigurationId": {
"eq": "<string>",
"in": ["<string>"]
},
"cloudProvider": {
"eq": "<string>",
"in": ["<string>"]
},
"managementType": {
"eq": "<string>",
"in": ["<string>"]
},
"region": {
"eq": "<string>",
"in": ["<string>"]
},
"type": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"name": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"accountId": {
"eq": "<string>",
"in": ["<string>"]
},
"service": {
"eq": "<string>",
"in": ["<string>"]
},
"resourceId": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"cloudId": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"searchBy": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"driftStatus": {
"eq": "<string>",
"in": ["<string>"]
},
"environmentId": {
"eq": "<string>",
"in": ["<string>"]
}
},
"orderBy": [["<unknown>"]]
}
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({
organizationId: '<string>',
filters: {
cloudConfigurationId: {eq: '<string>', in: ['<string>']},
cloudProvider: {eq: '<string>', in: ['<string>']},
managementType: {eq: '<string>', in: ['<string>']},
region: {eq: '<string>', in: ['<string>']},
type: {eq: '<string>', in: ['<string>'], like: '<string>'},
name: {eq: '<string>', in: ['<string>'], like: '<string>'},
accountId: {eq: '<string>', in: ['<string>']},
service: {eq: '<string>', in: ['<string>']},
resourceId: {eq: '<string>', in: ['<string>'], like: '<string>'},
cloudId: {eq: '<string>', in: ['<string>'], like: '<string>'},
searchBy: {eq: '<string>', in: ['<string>'], like: '<string>'},
driftStatus: {eq: '<string>', in: ['<string>']},
environmentId: {eq: '<string>', in: ['<string>']}
},
orderBy: [['<unknown>']]
})
};
fetch('https://api.env0.com/cloud/resources', 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/resources",
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([
'organizationId' => '<string>',
'filters' => [
'cloudConfigurationId' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'cloudProvider' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'managementType' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'region' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'type' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'name' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'accountId' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'service' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'resourceId' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'cloudId' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'searchBy' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'driftStatus' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'environmentId' => [
'eq' => '<string>',
'in' => [
'<string>'
]
]
],
'orderBy' => [
[
'<unknown>'
]
]
]),
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/cloud/resources"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"filters\": {\n \"cloudConfigurationId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"cloudProvider\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"managementType\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"region\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"accountId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"service\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"resourceId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"cloudId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"searchBy\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"driftStatus\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"environmentId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n }\n },\n \"orderBy\": [\n [\n \"<unknown>\"\n ]\n ]\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/cloud/resources")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"filters\": {\n \"cloudConfigurationId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"cloudProvider\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"managementType\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"region\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"accountId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"service\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"resourceId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"cloudId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"searchBy\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"driftStatus\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"environmentId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n }\n },\n \"orderBy\": [\n [\n \"<unknown>\"\n ]\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.env0.com/cloud/resources")
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 \"organizationId\": \"<string>\",\n \"filters\": {\n \"cloudConfigurationId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"cloudProvider\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"managementType\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"region\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"accountId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"service\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"resourceId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"cloudId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"searchBy\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"driftStatus\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"environmentId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n }\n },\n \"orderBy\": [\n [\n \"<unknown>\"\n ]\n ]\n}"
response = http.request(request)
puts response.read_body{
"resources": [
{
"service": "<string>",
"resourceId": "<string>",
"clickOpsCount": 123,
"apiOpsCount": 123,
"iacOpsCount": 123,
"firstSeen": "2023-11-07T05:31:56Z",
"lastSeen": "2023-11-07T05:31:56Z",
"organizationId": "<string>",
"isIgnored": true,
"accountId": "<string>",
"region": "<string>",
"type": "<string>",
"parentResourceId": "<string>",
"cloudId": "<string>",
"name": "<string>",
"metadata": {},
"severityManuallySetAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"cloudConfigurationId": "<string>",
"severity": 123,
"stateResource": {
"managed": true,
"resourceType": "<string>",
"logicalName": "<string>",
"organizationId": "<string>",
"environmentId": "<string>",
"deploymentLogId": "<string>",
"isDrifted": true,
"iacProvider": "<string>",
"moduleName": "<string>",
"cloudCompassResourceId": "<string>",
"cloudId": "<string>",
"region": "<string>",
"accountId": "<string>",
"id": "<string>"
}
}
],
"total": 123
}Cloud Compass
Find Cloud Resources
POST
/
cloud
/
resources
Find Cloud Resources
curl --request POST \
--url https://api.env0.com/cloud/resources \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"organizationId": "<string>",
"filters": {
"cloudConfigurationId": {
"eq": "<string>",
"in": [
"<string>"
]
},
"cloudProvider": {
"eq": "<string>",
"in": [
"<string>"
]
},
"managementType": {
"eq": "<string>",
"in": [
"<string>"
]
},
"region": {
"eq": "<string>",
"in": [
"<string>"
]
},
"type": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"name": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"accountId": {
"eq": "<string>",
"in": [
"<string>"
]
},
"service": {
"eq": "<string>",
"in": [
"<string>"
]
},
"resourceId": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"cloudId": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"searchBy": {
"eq": "<string>",
"in": [
"<string>"
],
"like": "<string>"
},
"driftStatus": {
"eq": "<string>",
"in": [
"<string>"
]
},
"environmentId": {
"eq": "<string>",
"in": [
"<string>"
]
}
},
"orderBy": [
[
"<unknown>"
]
]
}
'import requests
url = "https://api.env0.com/cloud/resources"
payload = {
"organizationId": "<string>",
"filters": {
"cloudConfigurationId": {
"eq": "<string>",
"in": ["<string>"]
},
"cloudProvider": {
"eq": "<string>",
"in": ["<string>"]
},
"managementType": {
"eq": "<string>",
"in": ["<string>"]
},
"region": {
"eq": "<string>",
"in": ["<string>"]
},
"type": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"name": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"accountId": {
"eq": "<string>",
"in": ["<string>"]
},
"service": {
"eq": "<string>",
"in": ["<string>"]
},
"resourceId": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"cloudId": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"searchBy": {
"eq": "<string>",
"in": ["<string>"],
"like": "<string>"
},
"driftStatus": {
"eq": "<string>",
"in": ["<string>"]
},
"environmentId": {
"eq": "<string>",
"in": ["<string>"]
}
},
"orderBy": [["<unknown>"]]
}
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({
organizationId: '<string>',
filters: {
cloudConfigurationId: {eq: '<string>', in: ['<string>']},
cloudProvider: {eq: '<string>', in: ['<string>']},
managementType: {eq: '<string>', in: ['<string>']},
region: {eq: '<string>', in: ['<string>']},
type: {eq: '<string>', in: ['<string>'], like: '<string>'},
name: {eq: '<string>', in: ['<string>'], like: '<string>'},
accountId: {eq: '<string>', in: ['<string>']},
service: {eq: '<string>', in: ['<string>']},
resourceId: {eq: '<string>', in: ['<string>'], like: '<string>'},
cloudId: {eq: '<string>', in: ['<string>'], like: '<string>'},
searchBy: {eq: '<string>', in: ['<string>'], like: '<string>'},
driftStatus: {eq: '<string>', in: ['<string>']},
environmentId: {eq: '<string>', in: ['<string>']}
},
orderBy: [['<unknown>']]
})
};
fetch('https://api.env0.com/cloud/resources', 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/resources",
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([
'organizationId' => '<string>',
'filters' => [
'cloudConfigurationId' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'cloudProvider' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'managementType' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'region' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'type' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'name' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'accountId' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'service' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'resourceId' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'cloudId' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'searchBy' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'like' => '<string>'
],
'driftStatus' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'environmentId' => [
'eq' => '<string>',
'in' => [
'<string>'
]
]
],
'orderBy' => [
[
'<unknown>'
]
]
]),
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/cloud/resources"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"filters\": {\n \"cloudConfigurationId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"cloudProvider\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"managementType\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"region\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"accountId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"service\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"resourceId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"cloudId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"searchBy\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"driftStatus\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"environmentId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n }\n },\n \"orderBy\": [\n [\n \"<unknown>\"\n ]\n ]\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/cloud/resources")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"filters\": {\n \"cloudConfigurationId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"cloudProvider\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"managementType\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"region\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"accountId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"service\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"resourceId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"cloudId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"searchBy\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"driftStatus\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"environmentId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n }\n },\n \"orderBy\": [\n [\n \"<unknown>\"\n ]\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.env0.com/cloud/resources")
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 \"organizationId\": \"<string>\",\n \"filters\": {\n \"cloudConfigurationId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"cloudProvider\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"managementType\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"region\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"accountId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"service\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"resourceId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"cloudId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"searchBy\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"like\": \"<string>\"\n },\n \"driftStatus\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"environmentId\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n }\n },\n \"orderBy\": [\n [\n \"<unknown>\"\n ]\n ]\n}"
response = http.request(request)
puts response.read_body{
"resources": [
{
"service": "<string>",
"resourceId": "<string>",
"clickOpsCount": 123,
"apiOpsCount": 123,
"iacOpsCount": 123,
"firstSeen": "2023-11-07T05:31:56Z",
"lastSeen": "2023-11-07T05:31:56Z",
"organizationId": "<string>",
"isIgnored": true,
"accountId": "<string>",
"region": "<string>",
"type": "<string>",
"parentResourceId": "<string>",
"cloudId": "<string>",
"name": "<string>",
"metadata": {},
"severityManuallySetAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"cloudConfigurationId": "<string>",
"severity": 123,
"stateResource": {
"managed": true,
"resourceType": "<string>",
"logicalName": "<string>",
"organizationId": "<string>",
"environmentId": "<string>",
"deploymentLogId": "<string>",
"isDrifted": true,
"iacProvider": "<string>",
"moduleName": "<string>",
"cloudCompassResourceId": "<string>",
"cloudId": "<string>",
"region": "<string>",
"accountId": "<string>",
"id": "<string>"
}
}
],
"total": 123
}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.
Body
application/json
Was this page helpful?
⌘I