Sign in

Post v0 city

post/v0/city

Request

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

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.

Idempotency-Keystring

Idempotency key for safe retries.

Request body

bootstrap_profile'k8s-cell' | 'kubernetes' | 'kubernetes-cell' | 'single-host-compat'

Optional bootstrap profile.

dirstring required

Directory to create the city in. Absolute or relative to $HOME.

providerstring

Provider name for the city's default session template. Mutually exclusive with start_command.

start_commandstring

Custom workspace start command for the city's default session template. Mutually exclusive with provider.

Response

Accepted

event_cursorstring required

Supervisor event-stream cursor captured before the async request was accepted. Pass this value as after_cursor to /v0/events/stream to receive the request result. A populated cursor resumes each city at its exact per-city position, so no unrelated historical backlog is replayed. The value 0 is returned only when no event provider is registered at capture time; passing 0 back requests a replay from zero for every provider present at resume time, which still delivers this request result because no provider predates the capture boundary.

request_idstring required

Correlation ID. Watch /v0/events/stream for request.result.city.create, request.result.city.unregister, or request.failed with this request_id.

Changes

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