getarchivepeers

Back to network

New since v30.2

Summary

Returns archive-relevant peer state for bootstrap, fallback debugging, and monitoring.

Description

Returns archive-relevant peer state for bootstrap, fallback debugging, and monitoring. This RPC reports observed and configured state only. NODE_ARCHIVE is a peer advertisement, not proof that the peer can serve all historical data.

Change Buckets

  • New since v30.2

Arguments

  • view (STR): Return view: "all", "summary", "connected", or "configured".

Results

  • value (OBJ): No description.
  • summary (OBJ): No description.
    • connected_advertised_archive_peers (NUM): Currently connected peers whose observed service bits include NODE_ARCHIVE
    • connected_archive_connections (NUM): Currently connected peers opened through -connectarchive
    • configured_archive_targets (NUM): Configured -connectarchive entries
    • connected_configured_archive_targets (NUM): Configured -connectarchive entries currently connected
  • connected (ARR, optional): Archive-relevant connected peers, included for view "all" or "connected"
    • value (OBJ): No description.
    • nodeid (NUM): Connected peer id
    • address (STR): (host:port) The IP address and port of the peer
    • connection_type (STR): Type of connection
    • archive_connection (BOOL): Whether this connection was opened from -connectarchive
    • advertises_archive (BOOL): Whether observed services include NODE_ARCHIVE
    • services (STR_HEX): The observed services offered
    • servicesnames (ARR): The observed services offered, in human-readable form
      • SERVICE_NAME (STR): The service name if it is recognised
  • configured (ARR, optional): Configured -connectarchive targets, included for view "all" or "configured"
    • value (OBJ): No description.
    • target (STR): Configured -connectarchive target as provided by the operator
    • source (STR): Configuration source, always "connectarchive" in this version
    • connected (BOOL): Whether this configured target currently has a matching connected peer
    • nodeid (NUM, optional): Connected peer id when connected=true

Examples

qbit-cli getarchivepeers

qbit-cli getarchivepeers "summary"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getarchivepeers", "params": ["connected"]}' -H 'content-type: application/json' http://127.0.0.1:8352/