The ATS API (named after the Aspera Transfer Service, the product that became the Aspera on Cloud transfer service) is an authenticated, REST API that enables users to manage client access to their cloud storage. Once a client has a transfer service access key for the cloud storage, they can:

  1. Authenticate transfers. For more information see:
  2. Use the Node API to:
    • Request and modify FASP transfers
    • Manage the cloud storage file system
    • Gather event metadata
    • Track usage and bandwidth

Endpoints

The ATS API includes the following endpoints:

Endpoint Description Methods Authentication

/v2/instances

Use to retrieve the instance ID(s) that correspond with your transfer service subscription(s).
The instance ID is required to create an ATS API key.
For a use case example, see Creating ATS API Keys.

GET

OAuth2

  • AoC bearer token
  • IBM ID token

/v2/api_keys

Use to create, retrieve, and delete ATS API keys. ATS API keys are an HTTP Basic authentication method that authorizes the user to send requests to the /pub/v1/access_keys endpoint and that does not expire. For a use case example, see Creating ATS API Keys. Requires the instance ID.

POST

GET

DELETE

OAuth2

  • AoC bearer token
  • IBM ID token

/pub/v1/access_keys

Use to create, modify, retrieve, and delete transfer service access keys. Transfer service access keys can be used to authorize Node API requests, as well as command line transfers and Desktop Client GUI connections. For use case examples, see Creating Transfer Service Access Keys with the ATS API and Managing Access Keys with the ATS API.

POST

PUT

GET

DELETE

HTTP Basic

  • ATS API key