Return the health of the wallet headless.

GET 
/health

Return the health of the wallet headless.

Request

Query Parameters

wallet_ids string

Wallet ids to check, comma-separated. If not provided, will not check any wallet.

include_fullnode boolean

Whether fullnode health should be checked and included in the response.

include_tx_mining boolean

Whether tx mining service health should be checked and included in the response.

Responses

200

A JSON with the health object. It will contain info about all components that were enabled and provided wallet ids.

application/json

Schema

Schema

any

success

Success

{
  "status": "pass",
  "description": "Wallet-headless health",
  "checks": {
    "Wallet <wallet-id>": [
      {
        "status": "pass",
        "componentType": "internal",
        "componentName": "Wallet <wallet-id>",
        "output": "Wallet is ready"
      }
    ],
    "Wallet <wallet-id-2>": [
      {
        "status": "pass",
        "componentType": "internal",
        "componentName": "Wallet <wallet-id-2>",
        "output": "Wallet is ready"
      }
    ],
    "fullnode": [
      {
        "status": "pass",
        "componentType": "fullnode",
        "componentName": "Fullnode <fullnode_url>",
        "output": "Fullnode is responding"
      }
    ],
    "txMining": [
      {
        "status": "pass",
        "componentType": "service",
        "componentName": "TxMiningService <tx_mining_url>",
        "output": "Tx Mining Service is healthy"
      }
    ]
  }
}

400

A JSON object with the reason for the error.

application/json

Schema

Schema

any

invalid-wallet-ids

Invalid wallet id

{
  "success": false,
  "message": "Invalid wallet id parameter."
}

no-component-included

No component was included in the request

{
  "success": false,
  "message": "At least one component must be included in the health check"
}

503

A JSON with the health object. It will contain info about all components that were checked.

application/json

Schema

Schema

any

unhealthy

Unhealthy wallet headless

{
  "status": "fail",
  "description": "Wallet-headless health",
  "checks": {
    "Wallet <wallet-id>": [
      {
        "status": "pass",
        "componentType": "internal",
        "componentName": "Wallet <wallet-id>",
        "output": "Wallet is ready"
      }
    ],
    "Wallet <wallet-id-2>": [
      {
        "status": "pass",
        "componentType": "internal",
        "componentName": "Wallet <wallet-id-2>",
        "output": "Wallet is ready"
      }
    ],
    "fullnode": [
      {
        "status": "fail",
        "componentType": "fullnode",
        "componentName": "Fullnode <fullnode_url>",
        "output": "Fullnode reported as unhealthy: <fullnode response>"
      }
    ],
    "txMining": [
      {
        "status": "pass",
        "componentType": "service",
        "componentName": "TxMiningService <tx_mining_url>",
        "output": "Tx Mining Service is healthy"
      }
    ]
  }
}

Loading...