Skip to Content
put.ioDevelopers
Register an app

Get a ZIP

GEThttps://api.put.io/v2/zips/{id}

Returns the status of a zip job. Poll until zip_status is DONE, then use url. WAITING means you have too many active zip jobs; the job waits its turn. missing_files lists files left out of the zip.

Path

idintegerRequired

Returns

200

zip_statusstring · enumRequired
NEWPROCESSINGWAITINGDONEERROR
urlstring | null · uriRequired

Null when zip_status is NEW, PROCESSING or ERROR. Set for WAITING too, but only usable when DONE.

sizeinteger | null

Present when zip_status is DONE or WAITING. Null while WAITING.

error_msgstring

Present only when zip_status is ERROR.

missing_filesarray | null

Present when zip_status is DONE or WAITING. Null while WAITING.

Errors

JSON with error_type, error_message, error_id and extra.

403ACCESS_DENIED when the zip belongs to another user.
410LINK_EXPIRED when the zip id is unknown or the link has expired.
500ERROR_IN_ZIP when no zip server is available.
429Too many requests. Limits are per token and per IP. Wait until X-RateLimit-Reset, then retry.