Sign in
hydra

Redeem a counterparty invite. (admin access required)

Changed on

Verifies the issuer's signature, provisions our own node, sends our material to the issuer's Exchange Plane and records the resulting relation and head. Spends a node and a peer port, and tells the counterparty we are ready, so it is deliberate rather than automatic.

post/hydra/invite/redeem

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

Request body

codestring required
hotWalletIdstring required

Wallet that will identify us on the resulting head

autoFundboolean

Send the node's L1 fuel from the chosen wallet straight away. On unless set false.

allowInsecureExchangeHttpboolean

Explicitly allow redemption over HTTP when a separately secured network protects the exchange

allowPrivateExchangeNetworkboolean

Explicitly allow redemption to private, loopback, link-local, or other special-use IP space

Example request

{}

Response

Invite redeemed

status'success' required

Example response

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

Changes