CloudFormation Template API

APIs to recommend parameters for, or generate, a CloudFormation Template script

Recommended parameters required to protect Internet Gateway

post/recommendedcftparams

Recommended parameters required to protect Internet Gateway

SecurityTrend Micro Cloud One API Key

Request

header Parameters

api-version

required

string

API version, e.g. v1

Request Body schema: application/json

accountId	string Account ID
azsToProtect	Array of strings AWS Availability Zones to be protected by Network Security
internetGatewayId	string Internet Gateway ID
region	string region

Responses

200

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples

Payload

application/json

{"accountId": "string",
"internetGatewayId": "string",
"region": "string",
"azsToProtect": ["us-east-2a",
"us-east-2b"
]
}

Response samples

application/json

{"messageCode": 0,
"message": "string",
"sshKeypairs": ["string"
],
"inspectionSubnets": [{"availabilityZone": "string",
"cidr": "string"
}
],
"managementSubnets": [{"availabilityZone": "string",
"cidr": "string"
}
],
"instanceTypes": ["string"
]
}

Generate CloudFormation Template script

post/protectigwcfts

Generate AWS CFT script to protect Internet Gateway

SecurityTrend Micro Cloud One API Key

Request

header Parameters

api-version

required

string

API version, e.g. v1

Request Body schema: application/json

accountId	string accountId
apiKey	string [ 3 .. 450 ] characters apiKey
azsToProtect	Array of strings AWS Availability Zones to be protected by Network Security
required	Array of objects (SubnetCidr) Inspection Subnets
instanceType	string Default: "c5.xlarge" AWS EC2 Instance Type
internetGatewayId	string Internet Gateway ID
required	Array of objects (SubnetCidr) Management Subnets
region	string region
scriptFormat	stringyaml\|json Script Format: yaml or json
sshKeypair	string sshKeypair

Responses

200

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples

Payload

application/json

{"internetGatewayId": "string",
"region": "string",
"sshKeypair": "string",
"inspectionSubnets": [{"availabilityZone": "string",
"cidr": "string"
}
],
"managementSubnets": [{"availabilityZone": "string",
"cidr": "string"
}
],
"instanceType": "c5.xlarge",
"apiKey": "string",
"accountId": "string",
"scriptFormat": "string",
"azsToProtect": ["us-east-2a",
"us-east-2b"
]
}

Response samples

application/json

{"messageCode": 0,
"message": "string",
"output": "string",
"scriptFormat": "string"
}

Return the status of edge deployment readiness checklist

post/awsaccountassets/validate-edge-deployment-readiness

Check edge deployment readiness of AWS availability zones

SecurityTrend Micro Cloud One API Key

Request

Request Body schema: application/json

accountId	string AWS Account ID
azsToProtect	Array of strings AWS Availability Zones to be protected by Network Security
region	string AWS Region
vpcId	string VPC ID

Responses

200

201

Created

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples

Payload

application/json

{"accountId": "1234567890",
"vpcId": "vpc-1234567890",
"region": "us-west-1",
"azsToProtect": ["us-east-2a",
"us-east-2b"
]
}

Response samples

application/json

{"vpcId": "vpc-1234567890",
"validationStatus": [{"validationName": "Internet Gateway attached to VPC",
"status": "pass",
"errors": [{"message": "Internet Gateway igw-1234567890 does not have an attached VPC"
}
],
"validationId": "ip_address_available_in_subnet",
"blockerValidationIds": "[attached_igw_to_vpc]"
}
]
}

➔ Next to Cross Account Role IAM Info API