Skip to content
handupbeta
Download

cleanup_get

View as Markdown
GET
/v1/storage/cleanup/{id}

Progress of a cleanup. Local, and view scope on paired devices.

id
required
string
Media typeapplication/json

A background cleanup. The daemon runs one at a time in small batches, so requests and decisions keep working while it runs.

object
id
required
string
target
required

What a cleanup removes.

string
Allowed values: history files
older_than_days
required

0 = every resolved request.

integer format: int32
keep_newest

Newest resolved requests kept; 0 = no count limit.

integer format: int32
state
required
string
Allowed values: running done cancelled failed
total
required

Items to process, counted at the start: requests (history) or files (files).

integer format: int64
done
required

Items processed so far.

integer format: int64
requests_deleted
required
integer format: int64
files_deleted
required
integer format: int64
bytes_freed
required

Bytes freed: removed files plus database pages released by deleted rows.

integer format: int64
compacting
required

Returning freed database pages to the filesystem (incremental vacuum).

boolean
started_at
required

Unix milliseconds.

integer format: int64
finished_at
integer | null format: int64
error

Set when state is failed.

string | null

Not the running or most recent cleanup