Skip to main content
POST
Force-release a stack's Terraform state lock

Path Parameters

id
string
required

Query Parameters

force
boolean | null

Release the lock while the run that took it is still active, or when the lock was taken outside a pipeline run. This covers a run that never completes and does not respond to cancellation, which is not expected behaviour. That run keeps going, and its state write is refused once the lock is gone, so the run fails and any cloud resources it already changed go unrecorded. State from completed operations is untouched. Cancel the run first whenever cancellation succeeds.

lockId
string | null

The lockId of the lock you reviewed, as returned by the lock endpoint. When the stack now holds a different lock, the request returns 409 and releases nothing, so a lock taken after you looked is never released in its place. An already-released lock still succeeds and changes nothing.

Response

The request has succeeded.

data
object
required

The state lock on a stack whose Terraform state Ravion stores.