Sign in
hydra

Sweep what a node did not spend back to its wallet. (admin access required)

Changed on

Returns the node's remaining ADA once its head is final. Refused while the head is still live or an invite still holds the node, because the node would need those funds.

post/hydra/participant/local/withdraw

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

Request body

idstring required

Local participant whose node should be swept

Example request

{
  "id": "cuid_v2_auto_generated"
}

Response

Node sweep result

status'success' required

Example response

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

Changes