Sign in
hydra

Register a Hydra Host. (admin access required)

Changed on

Registers a Hydra Host control plane. The user token grants runtime access to the proxied node API; the optional admin token additionally allows provisioning nodes on this Host. Both are stored encrypted and never returned.

post/hydra/host

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

Request body

namestring required

Operator-facing label

network'Preprod' | 'Mainnet' required
baseUrlstring required

Control-plane URL, e.g. https://hydra1.example.com. HTTPS is recommended.

allowInsecureHttpboolean

Explicitly allow bearer tokens over HTTP. Use only on a separately secured network.

publicPeerHoststring

Hostname the counterparty dials for this head’s peer port. Defaults to the host in baseUrl, which is right unless peers reach the Host by a different name than this service does.

userTokenstring

Runtime token for proxied node API access. Optional: the admin token also satisfies runtime calls, so supply this only to keep a lower-privilege token for day-to-day use.

adminTokenstring required

Provision, escrow-ack, reconfigure, delete. Required: without it no head can be opened here.

Response

Registered host

status'success' required

Example response

{
  "status": "success"
}

Changes