Data Portability

The data portability feature provides an efficient way to bulk export raw data from your Distributed Cloud AIP environment into your Amazon Web Services (AWS) Simple Storage Service (S3) bucket(s).

List S3 Export Enrollment

Overview

This method enables you to get a list of all AWS S3 export enrollments in your organization.

Sample Query

Find all the AWS S3 export enrollments in your organization:

https://api.threatstack.com/v2/integrations/s3export
Responses
200

OK

400

Bad parameters

401

Unauthorized response

403

Missing credentials

404

The resource was not found

429

Rate limit hit

500

An internal error has occurred

get/integrations/s3export
Response samples
application/json
{
  • "organization_id": "string",
  • "s3Bucket": "string",
  • "iamRoleArn": "stringstringstringst",
  • "iamRoleArnExternalId": "string",
  • "region": "string",
  • "prefix": "string",
  • "enrolledAt": "string",
  • "enabled": true,
  • "message": "string"
}

Update S3 Export Enrollment

Overview

This method enables you to update an AWS S3 export enrollment in your organization.

Sample Query

Update an AWS S3 export enrollment in your organization:

https://api.threatstack.com/v2/integrations/s3export
Request
Request Body schema: application/json
s3Bucket
required
string [ 3 .. 63 ] characters

The name of the S3 bucket into which to put raw events

  • The name can only contain lowercase letters, numbers, and/or dashes.
  • The name must start with a letter or number.
  • The name cannot be formatted as an IP address.
iamRoleArn
required
string [ 20 .. 2048 ] characters

The Role ARN generated at the time of IAM role creation

iamRoleArnExternalId
required
string [ 0 .. 1224 ] characters

The external ID generated at the time of IAM role creation

region
required
string

The valid AWS region of your AWS S3 bucket

prefix
required
string [ 0 .. 64 ] characters

Add a prefix name to put the exported events under a specific prefix in your AWS S3 bucket

enabled
required
boolean

Flag that shows whether data portability is enabled (true) or disabled (false)

Enum: true false
Responses
200

OK

400

Bad parameters

401

Unauthorized response

403

Missing credentials

429

Rate limit hit

500

An internal error has occurred

put/integrations/s3export
Request samples
application/json
{
  • "s3Bucket": "string",
  • "iamRoleArn": "stringstringstringst",
  • "iamRoleArnExternalId": "string",
  • "region": "string",
  • "prefix": "string",
  • "enabled": true
}
Response samples
application/json:
{
  • "organization_id": "string",
  • "s3Bucket": "string",
  • "iamRoleArn": "stringstringstringst",
  • "iamRoleArnExternalId": "string",
  • "region": "string",
  • "prefix": "string",
  • "enrolledAt": "string",
  • "enabled": true
}

Delete S3 Export Enrollment

Overview

This method enables you to delete an AWS S3 export enrollment in your organization.

Sample Query

Delete an AWS S3 export enrollment in your organization:

https://api.threatstack.com/v2/integrations/s3export
Request
Request Body schema: application/json
s3Bucket
required
string [ 3 .. 63 ] characters

The name of the S3 bucket to unenroll from the data portability integration.

NOTE: The S3 bucket name must be enrolled in the data portability integration for the delete to work.

Responses
200

OK

400

Bad parameters

401

Unauthorized response

403

Missing credentials

404

The resource was not found

429

Rate limit hit

500

An internal error has occurred

delete/integrations/s3export
Request samples
application/json
{
  • "s3Bucket": "string"
}
Response samples
application/json
{
  • "organization_id": "string",
  • "s3Bucket": "string"
}
➔ Next to Organization