Skip to navigation

Replace a managed sandbox deployment spec

Requires If-Match against the control-plane resource version. An identical normalized spec returns 200 and writes no new revision; a changed spec returns 202 with a new desired revision.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired>=1 character

Headers

idempotency-keystringOptional
Replays the stored response for the same authored body for seven days. Reusing a key with a different body returns 409.
if-matchstringOptional

Required for a fresh update: the expected resourceVersion. Missing or stale values return 412. Optional only for a matching Idempotency-Key replay, which returns its stored response before checking this precondition.

Request

This endpoint expects an object.
objectRequired
OR
objectRequired

Response

No change: the normalized desired spec already matches

deploymentobject
operationIdstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
412
Precondition Failed Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error