Runs

Get run by id

Returns job info.

get/runs/{id}

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Path parameters

idnumber required

Job run id

Response

Successful response

idnumber required

Job run id

job_idnumber required

Job id

typestring required

Job type

run_typestring required

Run type

namestring required

Job name

activeboolean required

Specify if currently running

run_idnumber required

Sequential number of job run

statusstring required

Job status. Possible values: working - Job run is working finished - Job run is finished successfully aborted - Job run was aborted timeout - Job run was aborted by timeout paused - Job run is paused

files_totalnumber

Total number of files

size_totalnumber

Total files size in bytes

files_completednumber

Number of completed files

size_completednumber

Size of completed files in bytes

transferrednumber

Bytes transferred

agents_completednumber required

Number of completed Agents

agents_totalnumber required

Number of all job Agents

agents_inprogressnumber required

Number of Agents in progress

agents_offlinenumber required

Number of offline Agents

agents_failednumber required

Number of failed Agents

start_timenumber

Job run start time (timestamp in seconds). For sync, file_caching and hybrid_work jobs it's the time when status working was set last time.

finish_timenumber

Job run finish time (timestamp in seconds). Not available for sync, file_caching and hybrid_work job

durationnumber

Job run duration (in seconds). For active sync, file_caching and hybrid_work jobs (status is not finished) it's difference between current time and start_time, otherwise it has 0 value.

last_syncednumber

sync, file_caching and hybrid_work job last synced time (in seconds)

down_speednumber

Total download speed

up_speednumber

Total upload speed

max_speednumber

Maximum job run speed

transfer_etanumber

Job run transfer eta in seconds. Not available for script job

progressnumber

Job run transfer progress. Not available for script job

started_bystring

User who started job run. Empty in case job run was started by scheduler

errorsobject required

List of errors

errors.codenumber

Error code (deprecated since 2.9.1)

errors.code_strstring required

Error string code

errors.messagestring required

Error message

errors.agent_idnumber

Agent id

errors.folderidnumber

Transfer id

event_logs_completeboolean

A property indicates that all event have been delivered. Applicable only to finished job runs except for sync, file_caching and hybrid_work job

Changes

No recorded changes to this operation across all 1 revision of this API.