Net API (1.0.0)
Download OpenAPI specification:Download
URL: https://eosnetwork.com License: MIT
Nodeos Net API Specification. See developer documentation at https://docs.eosnetwork.com for information on enabling this plugin.
connections
Returns an array of all peer connection statuses.
Request Body schema: application/json
object
Responses
Request samples
- Payload
Content type
application/json
{ }Response samples
- 200
Content type
application/json
[- {
- "peer": "string",
- "connecting": true,
- "syncing": true,
- "last_handshake": {
- "network_version": 0,
- "chain_id": "string",
- "node_id": "string",
- "key": "string",
- "time": "string",
- "token": "string",
- "sig": "string",
- "p2p_address": "string",
- "last_irreversible_block_num": 0,
- "last_irreversible_block_id": "string",
- "head_num": 0,
- "head_id": "string",
- "os": "string",
- "agent": "string",
- "generation": 0
}
}
]connect
Initiate a connection to a specified peer.
Request Body schema: application/json
| endpoint required | string the endpoint to connect to expressed as either IP address or URL |
Responses
Request samples
- Payload
Content type
application/json
{- "endpoint": "string"
}Response samples
- 200
Content type
application/json
"string"disconnect
Initiate disconnection from a specified peer.
Request Body schema: application/json
| endpoint required | string the endpoint to disconnect from, expressed as either IP address or URL |
Responses
Request samples
- Payload
Content type
application/json
{- "endpoint": "string"
}Response samples
- 200
Content type
application/json
"string"status
Retrieves the connection status for a specified peer.
Request Body schema: application/json
| endpoint required | string the endpoint to get the status for, to expressed as either IP address or URL |
Responses
Request samples
- Payload
Content type
application/json
{- "endpoint": "string"
}Response samples
- 200
Content type
application/json
{- "peer": "string",
- "connecting": true,
- "syncing": true,
- "last_handshake": {
- "network_version": 0,
- "chain_id": "string",
- "node_id": "string",
- "key": "string",
- "time": "string",
- "token": "string",
- "sig": "string",
- "p2p_address": "string",
- "last_irreversible_block_num": 0,
- "last_irreversible_block_id": "string",
- "head_num": 0,
- "head_id": "string",
- "os": "string",
- "agent": "string",
- "generation": 0
}
}