Start a storage integrity sweep

POST

/admin/storage/sweeps

• Local development behind nginx (port 8088 by default)

Opens a sweep run and enqueues the first batch (#403). The job re-enqueues itself with an advancing cursor until the scan completes, so this returns as soon as the work is queued — the run shows up in the jobs admin queue while it works.

A MUTATION in the sense that it creates work, so it is gated on system.admin, mirroring the jobs requeue/cancel split. The sweeps themselves are read-only against storage: they record findings and never delete.

Authorizations

• cookieAuth
• bearerAuth

Request Body ^required

object

kind

required

Which sweep to run.

string

Allowed values: orphan_scan checksum_verify

Responses

202

Sweep queued.

object

id

required

string format: uuid

kind

required

string

Example

orphan_scan

status

required

string

Allowed values: running completed failed

objects_scanned

required

integer format: int64

findings_count

required

integer format: int64

started_at

string format: date-time

nullable

finished_at

string format: date-time

nullable

error

string

nullable

400

Malformed request

object

error

required

Human-readable error summary

string

Example

the request could not be completed

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed