net_api_plugin

See Net API Reference.

Overview

The net_api_plugin exposes functionality from the net_plugin to the RPC API interface managed by the http_plugin. The net_api_plugin allows node operators to manage the peer-to-peer (p2p) connections of an active node.

The net_api_plugin provides four RPC API endpoints:

• connect
• disconnect
• connections
• status

⚠️ 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

• net_plugin
• http_plugin

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]