Nearly identical to the drill-down detail screen for a transfer.

Request (GET)

An Example URL

https://console.asperasoft.com/aspera/console/api/transfers/885278

Reply

If Success, a hash with the details of the transfer is returned, an example of this is seen below. If Error, an error code is returned, normally 422.

 

Descriptions of Reply Fields

bytes_transferred
Total bytes actually transferred over network. Bytes that were already present at the destination at the start of the transfer are not counted if the transfer was started with 'resume' option enabled.
bytes_written
Total bytes completed and have been written to the disk at the destination. May be larger than 'bytes_transferred' because it includes bytes that were already present at the destination (i.e. of files were already there or this is a retry for an interrupted transfer)
contact
Contact as shown in Console UI, generally either an ssh account or Console/Faspex username. Can be affected by cookie parsing rules.
destination
IP address of destination machine
error_description
Error description as shown in Console UI
eta
Estimated time for the transfer to complete based on the current actual rate and 'total_bytes'. Depends on presence and accuracy of 'total_bytes' (see below)
id
Console's numeric id for the transfer.
last_calculated_rate_bps While a transfer is running, Console will attempt to periodically calculate the current actual (as opposed to target) transfer rate by comparing how much the bytes_transferred and microseconds_elapsed have changed since the last time Console checked the transfer. This field is supplied as a convenience to allow users to see approximate current achieved rate. For short transfers the Console may not get a chance to compute this value before the transfer ends - in this case, this field will return null. If you wish to calculate average bitrate for the entire transfer, use (bytes_transferred * 8) / (stopped_at - started_at) instead.
name
Name of the transfer as shown in Console UI. Can be affected by cookie parsing rules.
queued_at
Time that a transfer was first placed on a queue. Null for transfers not started from Console UI/API.
scheduled_start_at
Time that a transfer is/was scheduled to start. Null if the scheduled start time was not specified or transfer was not started from Console UI/API.
source
IP address of the source machine
source_paths
List of specified source items from the ascp command that started the transfer. NOTE: This value is truncated to approximately 4KB so it may not contain the full list.
started_at
Start time of the first session. Null if no transfer session has started yet or if managed node failed to log transfer.
started_via
'Started via' field as shown in Console UI. Can be affected by cookie parsing rules.
status
Status of transfer as shown in Console UI.
submitted_at
Time that the transfer was submitted to Aspera Central by the initiating managed node (i.e. the client). Null for transfers not started from Console UI/API.
stopped_at
Stop time of the last session. Null if the session is still running, no session has started yet or if the managed node failed to log the transfer.
total_bytes
Total bytes to transfer, as computed by the source node at the start of the current transfer session. The source node must be configured to provide this information, otherwise the value will be null. This value might be inaccurate (too low) for hot folder transfers, particularly Windows push hot folders, as it may take more than one session to transfer all files. It may also be inaccurate if files are added/deleted from source directory while the transfer session is running.
Video player

Video

×