hydra

Enable or disable a Hydra head. (admin access required)

Changed on

Enabling re-verifies the head/participants/InitTx on L1 before re-admitting it; disabling quarantines it (drops its InitTx admission).

patch/hydra/head

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
  • Auth: API key in header token

Request body

idstring required

ID of the HydraHead to update

isEnabledboolean required

Whether the head should be enabled

Example request

{
  "id": "cuid_v2_auto_generated",
  "isEnabled": true
}

Response

Hydra head updated

status'success' required

Example response

{
  "status": "success",
  "data": {
    "id": "cuid_v2_auto_generated"
  }
}

Changes