Cloud Connect

Get an AWS account

Returns the current state of an AWS account including role, supported features, and optional S3 bucket configuration.

get/core/v1/cloudconnect/aws/accounts/{accountID}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/core/v1/cloudconnect/aws/accounts/{accountID}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Response

OK - Account details returned successfully.

accountIDstring

The AWS account ID.

roleArnstring

The ARN of the IAM role.

s3Bucketstring

S3 bucket name for real-time anomaly detection. Present only if real-time is enabled.

s3BucketRegionstring

AWS region of the S3 bucket. Present only if s3Bucket exists.

enabledFeaturesstring[]

List of supported AWS features enabled by the caller. Returned in the same order as provided.

timeLinkedstring

ISO 8601 timestamp of when the role was linked.

Example response

{
  "accountID": "123456789012",
  "roleArn": "arn:aws:iam::123456789012:role/DoiTRole",
  "s3BucketRegion": "us-east-1",
  "supportedFeatures": [
    {
      "name": "spot-scaling"
    }
  ],
  "timeLinked": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.