Sign in
hydra

Run the Hydra head close lifecycle action. (admin access required)

Changed on

Submits the close transaction for the head through the local Hydra node. Refused while the head still holds escrows or unconfirmed L2 work unless acknowledgeActiveEscrows is set, which accepts that those escrows move to L1 and must be collected there.

post/hydra/head/close

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/hydra/head/close
  • Auth: API key in header token

Request body

headIdstring required

ID of the HydraHead

acknowledgeActiveEscrowsboolean

Example request

{
  "headId": "cuid_v2_auto_generated"
}

Response

Head close result

status'success' required

Example response

{
  "status": "success",
  "data": {
    "headId": "cuid_v2_auto_generated",
    "status": "Closed"
  }
}

Changes