POST /data/v1/filetransferlocation
This method creates a new AWS S3, or External SFTP file location. For each of the two types, parameters differ slightly, with differences shown below.
Installed Packages > Data > File Locations > Write
Scope: file_locations_write
Parameters Common to Both File Location Types
| Name | Type | Description | |
|---|---|---|---|
| fileTransferLocation.name | string | required | A name for your file location that identifies the location. |
| fileTransferLocation.customerKey | string | optional | The key used when using the API. |
| fileTransferLocation.description | string | optional | A description of the file location. |
| fileTransferLocation.locationType | string | optional | One of two possible types of file location, either AmazonSimpleStorage or ExternalSFTP. |
Additional Parameters for a New AWS S3 File Location
| Name | Type | Description | |
|---|---|---|---|
| fileTransferLocation.awsFileTransferLocation.authType | string | required | The authorization method for the system to access the location. Values can be AccessKey or AccessKeyWithIAMRole. |
| fileTransferLocation.awsFileTransferLocation.accessKeyId | string | required | The AWS Access Key ID for authorization. |
| fileTransferLocation.awsFileTransferLocation.secretAccessKey | string | required | The AWS Secret Access Key for authorization. |
| fileTransferLocation.awsFileTransferLocation.roleArn | string | required if authType=AccessKeyWithIAMRole | For AWS IAM Role authorization, use the Role ARN found in AWS. For example, arn:aws:iam::1234567890 |
| fileTransferLocation.awsFileTransferLocation.regionName | string | required | The region location of the bucket. For example, US-West (Oregon). See Supported AWS Regions below. |
| fileTransferLocation.awsFileTransferLocation.bucketname | string | required | The name of your bucket in AWS. |
| fileTransferLocation.awsFileTransferLocation.relativepath | string | optional | The relative location inside the bucket. Don’t use a leading or trailing “/” in your path. |
Supported AWS Regions
| AWS Region | regionName (value required via API) |
|---|---|
| US East (Virginia) | useast1 |
| US West (N. California) | uswest1 |
| US West (Oregon) | uswest2 |
| EU West (Ireland) | euwest1 |
| EU Central (Frankfurt) | eucentral1 |
| Asia Pacific (Tokyo) | apnortheast1 |
| Asia Pacific (Singapore) | apsoutheast1 |
| Asia Pacific (Sydney) | apsoutheast2 |
| South America (Sao Paulo) | saeast1 |
| China (Beijing) | cnnorth1 |
| US East (Ohio) | useast2 |
| EU North (Stockholm) | eunorth1 |
| EU West (London) | euwest2 |
| EU West (Paris) | euwest3 |
| Europe (Milan) | eusouth1 |
| Asia Pacific (Hong Kong) | apeast1 |
| Asia Pacific (Seoul) | apnortheast2 |
| Asia Pacific (Osaka-Local) | apnortheast3 |
| Asia Pacific (Mumbai) | apsouth1 |
| China (Ningxia) | cnnorthwest1 |
| Canada (Central) | cacentral1 |
| Middle East (Bahrain) | mesouth1 |
| Africa (Cape Town) | afsouth1 |
Additional Parameters for a New External SFTP File Location
| Name | Type | Description | |
|---|---|---|---|
| fileTransferLocation.sFtpFileTransferLocation.authType | string | required | Choose the authorization method for the system to access the location. authType = password OR authKey |
| fileTransferLocation.sFtpFileTransferLocation.url | string | required | URL to the external SFTP location |
| fileTransferLocation.sFtpFileTransferLocation.username | string | required | Username to the external SFTP location |
| fileTransferLocation.sFtpFileTransferLocation.password | string | required if authType=password | Password to the external SFTP location |
| fileTransferLocation.sFtpFileTransferLocation.keyManagementPublicKey | string | required if authType=authKey | Password to the external SFTP location |
Example Request
Example Response
Example Request
Example Response