List storage information

File Storage Security has a list file stores API. It returns a list of all storage units in the cloud account, and indicates which units are protected by File Storage Security and which are not. The storage unit type depends on your cloud accounts -- S3 buckets in AWS, storage accounts in Azure and storage buckets in GCP.

Currently the API only supports AWS.

Prerequisite

To use the API you need a cloud account in Trend Micro Cloud One. See How to set up an AWS cloud account.

Sample response

The File Stores API can be run on your cloud accounts on a set schedule using a job scheduler. There will be some delay to see the latest file units in the API response.

Currently the API only supports listing S3 Buckets in AWS.

The API response lists all S3 buckets of the AWS account. The individual storage units are listed in the file store array. The following example shows the details of an S3 bucket.

{
    "fileStores": [
        {
            "name": "example-bucket",
            "provider": "aws",
            "providerAccount": "123456789012",
            "details": {
                "arn": "arn:aws:s3:::example-bucket",
                "monitoredBy": "60e53669-c8ef-4d0f-a8ff-3dbbb098d8ff"
            }
        }
    ],
    "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}

You can check the 'monitoredBy' attribute to see whether a file storage unit is protected by File Storage Security or not. The attribute 'monitoredBy' shows the identifier of the File Storage Security storage stack. If this property is absent, the file storage unit is unprotected -- it is not associated with, and monitored by a File Storage Security storage stack. If this property is present, the file storage unit is protected -- it is associated with, and monitored by, a File Storage Security storage stack. Files uploaded to this file storage unit will trigger a scan by the File Storage Security scanner stack.