File Transfer Locations

GET Get a file transfer location identified by customerKey.

GET /data/v1/filetransferlocation/{customerkey}

Operation ID: Get a file transfer location.

This method returns a single file location for the given customer key.

Required Scopes

Installed Packages > Data > File Locations > Read

Scope: 'file_locations_read';

Parameters

• customerkey (path, string, required) The customerkey of the FileTransferLocation to retrieve.
  Example: AWS_Marketing_Bucket.

Responses

• 200 OK

  Media type: application/json. Schema: any.

  Type: any.

  Example: Example Response

  {
      "fileTransferLocation": {
          "customerKey": "AWS_Marketing_Bucket",
          "name": "AWS Marketing Bucket",
          "description": "Marketing files",
          "locationType": "AmazonSimpleStorage",
          "awsFileTransferLocation": {
              "accessKeyId": "ASLKJMO45MTESTBYR3Q",
              "roleArn": "arn:aws:iam::123456789:role/Marketing_Role",
              "regionName": "useast1",
              "relativePath": "winter/registrations",
              "bucketName": "marketing",
              "authType": "AccessKeyWithIamRole"
          }
      },
      "requestId": "f6204345-9600-4464-8fc0-96c701234e11",
      "resultMessages": []
  }