v1

latestOpenAPI 3.1.02026-07-261690320.7 KB

Connect AWS cloud

Connect a new AWS cloud environment

post/clouds/aws

Request body

role_arnstring required

The ARN for the role that was created in the AWS account that Aikido can assume to access resource policies.

namestring required

A name for this cloud environment.

environment'production' | 'staging' | 'development' | 'mixed' required

Indicates for what environment this cloud is responsible.

Example request

{
  "role_arn": "arn:aws:iam::000000000000:role/aikido-security-readonly-AikidoSecurityRole-4TOEYPDQ5X3V",
  "name": "AWS Cloud environment",
  "environment": "production"
}

Response

The cloud environment has been successfully connected

idinteger

The ID of the newly connected cloud environment in Aikido.

Example response

{
  "id": 1
}