v1

latestOpenAPI 3.0.1AGPLv32026-07-17302746.4 KB

transfer info

Returns info about current transfer

get/api/v1/transfer

Response

OK

type'NO_TRANSFER' | 'FROM_WEB' | 'FROM_CONNECT' | 'FROM_PRINTER' | 'FROM_SLICER' | 'FROM_CLIENT' | 'TO_CONNECT' | 'TO_CLIENT' required
display_namestring required

Long Filename

pathstring required
urlstring
sizestring

Bytes

progressnumber required

Percents

transferredinteger required

Transferred data in bytes

time_remaininginteger

Seconds

time_transferringinteger required

Seconds

to_printboolean required

Whether or not print after finishing transfer (upload)

Example response

{
  "type": "FROM_WEB",
  "display_name": "Spice_Harvester_0.3mm_PLA_MK3S_12m.gcode",
  "path": "/local",
  "url": "https://files.printables.com/media/prints/42/gcodes/42_b42-242-442-8142c-424242/spice_harvester_0.3mm_pla_mk3s_12m.gcode",
  "progress": 42.25,
  "transferred": 3276800,
  "time_remaining": 61,
  "time_transferring": 42
}