Onboard AWS account
curl --request POST \
--url https://{host}/api/v2/analysis/cloud/aws/analyze \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "<string>",
"roleArnName": "<string>",
"roleExternalId": "<string>",
"connectionName": "<string>",
"triggerAdhocAudit": "<string>",
"startDayOffset": "<string>",
"endDayOffset": "<string>",
"webHook": {
"uri": "<string>",
"authType": "<string>",
"authValue": "<string>"
}
}
'import requests
url = "https://{host}/api/v2/analysis/cloud/aws/analyze"
payload = {
"accountId": "<string>",
"roleArnName": "<string>",
"roleExternalId": "<string>",
"connectionName": "<string>",
"triggerAdhocAudit": "<string>",
"startDayOffset": "<string>",
"endDayOffset": "<string>",
"webHook": {
"uri": "<string>",
"authType": "<string>",
"authValue": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
accountId: '<string>',
roleArnName: '<string>',
roleExternalId: '<string>',
connectionName: '<string>',
triggerAdhocAudit: '<string>',
startDayOffset: '<string>',
endDayOffset: '<string>',
webHook: {uri: '<string>', authType: '<string>', authValue: '<string>'}
})
};
fetch('https://{host}/api/v2/analysis/cloud/aws/analyze', 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://{host}/api/v2/analysis/cloud/aws/analyze",
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([
'accountId' => '<string>',
'roleArnName' => '<string>',
'roleExternalId' => '<string>',
'connectionName' => '<string>',
'triggerAdhocAudit' => '<string>',
'startDayOffset' => '<string>',
'endDayOffset' => '<string>',
'webHook' => [
'uri' => '<string>',
'authType' => '<string>',
'authValue' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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://{host}/api/v2/analysis/cloud/aws/analyze"
payload := strings.NewReader("{\n \"accountId\": \"<string>\",\n \"roleArnName\": \"<string>\",\n \"roleExternalId\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"triggerAdhocAudit\": \"<string>\",\n \"startDayOffset\": \"<string>\",\n \"endDayOffset\": \"<string>\",\n \"webHook\": {\n \"uri\": \"<string>\",\n \"authType\": \"<string>\",\n \"authValue\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://{host}/api/v2/analysis/cloud/aws/analyze")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"<string>\",\n \"roleArnName\": \"<string>\",\n \"roleExternalId\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"triggerAdhocAudit\": \"<string>\",\n \"startDayOffset\": \"<string>\",\n \"endDayOffset\": \"<string>\",\n \"webHook\": {\n \"uri\": \"<string>\",\n \"authType\": \"<string>\",\n \"authValue\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/v2/analysis/cloud/aws/analyze")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"<string>\",\n \"roleArnName\": \"<string>\",\n \"roleExternalId\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"triggerAdhocAudit\": \"<string>\",\n \"startDayOffset\": \"<string>\",\n \"endDayOffset\": \"<string>\",\n \"webHook\": {\n \"uri\": \"<string>\",\n \"authType\": \"<string>\",\n \"authValue\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"href": "<string>",
"message": "<string>",
"status": 123
}AWS: Onboard Accounts
Onboard AWS account
Initiates AWS CloudWatch data collection and runs optimization analysis. Subsequent data collection and analysis are scheduled nightly. If an analysis already exists, this endpoint re-runs analysis and can update the webhook for result delivery.
POST
/
analysis
/
cloud
/
aws
/
analyze
Onboard AWS account
curl --request POST \
--url https://{host}/api/v2/analysis/cloud/aws/analyze \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "<string>",
"roleArnName": "<string>",
"roleExternalId": "<string>",
"connectionName": "<string>",
"triggerAdhocAudit": "<string>",
"startDayOffset": "<string>",
"endDayOffset": "<string>",
"webHook": {
"uri": "<string>",
"authType": "<string>",
"authValue": "<string>"
}
}
'import requests
url = "https://{host}/api/v2/analysis/cloud/aws/analyze"
payload = {
"accountId": "<string>",
"roleArnName": "<string>",
"roleExternalId": "<string>",
"connectionName": "<string>",
"triggerAdhocAudit": "<string>",
"startDayOffset": "<string>",
"endDayOffset": "<string>",
"webHook": {
"uri": "<string>",
"authType": "<string>",
"authValue": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
accountId: '<string>',
roleArnName: '<string>',
roleExternalId: '<string>',
connectionName: '<string>',
triggerAdhocAudit: '<string>',
startDayOffset: '<string>',
endDayOffset: '<string>',
webHook: {uri: '<string>', authType: '<string>', authValue: '<string>'}
})
};
fetch('https://{host}/api/v2/analysis/cloud/aws/analyze', 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://{host}/api/v2/analysis/cloud/aws/analyze",
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([
'accountId' => '<string>',
'roleArnName' => '<string>',
'roleExternalId' => '<string>',
'connectionName' => '<string>',
'triggerAdhocAudit' => '<string>',
'startDayOffset' => '<string>',
'endDayOffset' => '<string>',
'webHook' => [
'uri' => '<string>',
'authType' => '<string>',
'authValue' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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://{host}/api/v2/analysis/cloud/aws/analyze"
payload := strings.NewReader("{\n \"accountId\": \"<string>\",\n \"roleArnName\": \"<string>\",\n \"roleExternalId\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"triggerAdhocAudit\": \"<string>\",\n \"startDayOffset\": \"<string>\",\n \"endDayOffset\": \"<string>\",\n \"webHook\": {\n \"uri\": \"<string>\",\n \"authType\": \"<string>\",\n \"authValue\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://{host}/api/v2/analysis/cloud/aws/analyze")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"<string>\",\n \"roleArnName\": \"<string>\",\n \"roleExternalId\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"triggerAdhocAudit\": \"<string>\",\n \"startDayOffset\": \"<string>\",\n \"endDayOffset\": \"<string>\",\n \"webHook\": {\n \"uri\": \"<string>\",\n \"authType\": \"<string>\",\n \"authValue\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/v2/analysis/cloud/aws/analyze")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"<string>\",\n \"roleArnName\": \"<string>\",\n \"roleExternalId\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"triggerAdhocAudit\": \"<string>\",\n \"startDayOffset\": \"<string>\",\n \"endDayOffset\": \"<string>\",\n \"webHook\": {\n \"uri\": \"<string>\",\n \"authType\": \"<string>\",\n \"authValue\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"href": "<string>",
"message": "<string>",
"status": 123
}Body
application/json

