This endpoint requests the transfer specification needed for a transfer.

Request Format

api/users/{user_id}|{package_id}/packages/{package_id}/transfer_specs --data '{"direction": "send" | "receive"}'

Request Parameters

Parameter Name Required/Optional Type Description
direction required string Direction of transfer

Example Request and Response

curl -H "Accept: application/json" -H "Content-type: application/json" -H "Authorization: Bearer 9xh8lVuHfwgRp_61swbxBA" https://example.com/aspera/faspex/api/users/me/packages/23592/transfer_specs --data '{"direction": "send"}'

{
    "source_root": "",
    "destination_root": "/asd - 2fb0b61e-ec57-4171-b540-15eab3179a34.aspera-package/PKG - asd/",
    "paths": [
        {
            "destination": "asd - 2fb0b61e-ec57-4171-b540-15eab3179a34.aspera-package/PKG - asd/"
        }
    ],
    "content_protection": null,
    "target_rate_kbps": 20000,
    "target_rate_cap_kbps": 100000,
    "rate_policy": "fair",
    "rate_policy_allowed": "fixed",
    "cipher": "aes-128",
    "cipher_allowed": null,
    "remote_host": "example.com",
    "remote_user": "faspex",
    "ssh_port": 33001,
    "fasp_port": 33001,
    "http_fallback": true,
    "http_fallback_port": 443,
    "https_fallback_port": null,
    "sshfp": null,
    "cookie": "aspera.faspex20:u:6d2fc967-72ef-4252-8f2f-ebe87e104885:amVmZg:eyJfcGtnX3V1aWQiOiIyZmIwYjYxZS1lYzU3LTQxNzEtYjU0MC0xNWVhYjMxNzlhMzQiLCJfcGtnX25hbWUiOiJhc2QiLCJfY3JlYXRlZF91dGMiOiIyMDE3LzEwLzEzIDE4OjQ5OjQ0ICswMDAwIn0:YXNk",
    "tags": {
        "aspera": {
            "faspex": {
                "requestor": {
                    "name": "josh",
                    "first_name": "Josh",
                    "last_name": "James",
                    "email": "josh@example.com",
                    "Department": "Dev",
                    "Location": ""
                },
                "metadata": {
                    "_pkg_uuid": "2fb0b61e-ec57-4171-b540-15eab3179a34",
                    "_pkg_name": "asd",
                    "_created_utc": "2017/10/13 18:49:44 +0000"
                },
                "recipients": [
                    {
                        "name": "admin",
                        "first_name": "Aspera",
                        "last_name": "Admin",
                        "email": "se@example.com",
                        "Department": "SE",
                        "Location": ""
                    }
Video player

Video

×