Trigger a Dolt store maintenance run

Trigger a one-off maintenance cycle (dolt backup + CALL DOLT_GC + smoke test). Default async (202); ?wait=true blocks until completion (200). Returns 409 when a run is already in flight.

post/v0/city/{cityName}/maintenance/dolt-gc

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: X-GC-Request

Path parameters

cityNamestring required

City name.

Query parameters

waitboolean

When true, the handler blocks until the run completes and returns 200 with the full Run. When false (default), the handler returns 202 Accepted immediately.

Headers

X-GC-Requeststring required

Anti-CSRF header required on mutation requests. Any non-empty value is accepted; the header's presence is what the server checks.

Response

Accepted

acceptedboolean required

True when the supervisor accepted the trigger (202) or completed it (200).

started_atstring

RFC3339 start time of the triggered run; doubles as a run identifier for async callers.

Changes

No recorded changes to this operation across all 50 revisions of this API.