AWS Connectors API

APIs for creating, deleting, and retrieving the aws connectors

List aws connectors

get/awsconnectors
Request
query Parameters
cursor
string
Default: ""
limit
integer <int32>
Default: 10
header Parameters
api-version
required
string

API version

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "crossAccountRoles": [
    ]
}

Create new aws connector

post/awsconnectors
Request
header Parameters
api-version
required
string

API version

Request Body schema: application/json
accountName
string [ 0 .. 255 ] characters

Account name

crossAccountRole
string [ 0 .. 2048 ] characters arn:aws:iam::[0-9]{12}:role/.*

Cross Account Role

externalId
string [ 1 .. 255 ] characters

External ID. This value should be same as the Trend Micro Cloud One account ID. If this parameter is not provided, the CloudOne account ID is used by default.

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples
application/json
{
  • "accountName": "string",
  • "crossAccountRole": "string",
  • "externalId": "string"
}
Response samples
application/json
{
  • "id": 0,
  • "accountId": "string",
  • "accountName": "string",
  • "crossAccountRole": "string",
  • "externalId": "string"
}

Delete AWS connector

delete/awsconnectors/{id}
Request
path Parameters
id
required
integer <int64>
header Parameters
api-version
required
string

API version, e.g. v1

Responses
200

OK

204

No Content

401

Unauthorized

403

Forbidden

500

Internal Server Error

Response samples
application/json
{ }