Skip to main content
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>"
  }
}
'
{
  "href": "<string>",
  "message": "<string>",
  "status": 123
}

Body

application/json
​
accountId
string
required

The AWS account ID with the CloudWatch data to collect.

​
roleArnName
string
required

ARN for the IAM role created in AWS for data collection.

​
roleExternalId
string
required

External ID specified for Kubex when the IAM role was created.

​
connectionName
string

Optional friendly name for this connection (max 32 chars; must be unique within type).

​
triggerAdhocAudit
string

Optional flag to trigger a one-time 60-day historical audit.

​
startDayOffset
string

Optional start offset from the 60-day maximum for historical collection.

​
endDayOffset
string

Optional end offset from “yesterday” for historical collection.

​
webHook
object

Response

Acknowledge request / analysis state

​
href
string

Referenced resource to the analysis entity or status endpoint.

​
message
string

Human-readable message describing the result.

​
status
integer

HTTP response code of the request.