Sign in
hydra

List or get Hydra heads. (admin access required)

Changed on

Lists Hydra heads with lifecycle status, participants and reconciliation state. Filter by id, relationId, status, or isEnabled.

get/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

Query parameters

idstring

Get a single head by ID

relationIdstring

Filter by HydraRelation ID

network'Preprod' | 'Mainnet'

Filter by Cardano network

status'Disconnected' | 'Connected' | 'Connecting' | 'Idle' | 'Initializing' | 'Open' | 'Closed' | 'FanoutPossible' | 'Final'

Filter by head status

isEnabledstring

Filter by isEnabled

cursorIdstring

Cursor ID for pagination

limitnumber

Number of results

Response

Hydra heads

status'success' required

Example response

{
  "status": "success",
  "data": {
    "heads": []
  }
}

Changes