Skip to main content

net api plugin

Description

The net_api_plugin exposes functionality from the net_plugin to the RPC API interface managed by the http_plugin. Node operators can use the net_api_plugin to manage the p2p connections of an active node.

The net_api_plugin provides four RPC API endpoints:

  • connect
  • disconnect
  • connections
  • status

See Net API Reference Documentation.

[[caution | Caution]] | This plugin exposes endpoints that allow management of p2p connections. Running this plugin on a publicly accessible node is not recommended as it can be exploited.

Usage

# config.ini
plugin = eosio::net_api_plugin
# command-line
nodeos ... --plugin eosio::net_api_plugin

Options

None

Dependencies

Load Dependency Examples

# config.ini
plugin = eosio::net_plugin
[options]
plugin = eosio::http_plugin
[options]
# command-line
nodeos ... --plugin eosio::net_plugin [options] \
--plugin eosio::http_plugin [options]