transfer info

Returns info about current transfer

get/api/v1/transfer

Response

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
}

Changes

Changed in 5 of the 49 revisions of this API.2112

Mar 21, 2023211b6b2b66ca110See the full diff
- ●
  removed the optional property transfer from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property size to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property time_remaining to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property url to the response with the 200 status
  response-optional-property-added
- ○
  added the required property display_name to the response with the 200 status
  response-required-property-added
- ○
  added the required property path to the response with the 200 status
  response-required-property-added
- ○
  added the required property progress to the response with the 200 status
  response-required-property-added
- ○
  added the required property time_transferring to the response with the 200 status
  response-required-property-added
- ○
  added the required property to_print to the response with the 200 status
  response-required-property-added
- ○
  added the required property transferred to the response with the 200 status
  response-required-property-added
- ○
  added the required property type to the response with the 200 status
  response-required-property-added
Feb 27, 2023d35fc1b8f1a71See the full diff
- ○
  endpoint added
  endpoint-added
Feb 17, 20231f95332338b41See the full diff
- ○
  endpoint added
  endpoint-added
Feb 16, 202394071d81ccf61See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 22, 202130eda14983ed1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history