22 lines
1.3 KiB
Markdown
Raw Normal View History

# REST API
2021-09-22 15:52:42 +02:00
Nimbus supports the [common REST API](https://ethereum.github.io/beacon-APIs/) for runtime communication.
> The REST API is currently in BETA -- to enable it, use the `--rest` option when starting the beacon node, then access the API from http://localhost:5052/.
The API is a REST interface, accessed via HTTP. The API should not, unless protected by additional security layers, be exposed to the public Internet as the API includes multiple endpoints which could open your node to denial-of-service (DoS) attacks through endpoints triggering heavy processing. Currently, the only supported return data type is JSON.
The beacon node (BN) maintains the state of the beacon chain by communicating with other beacon nodes in the Ethereum network. Conceptually, it does not maintain keypairs that participate with the beacon chain.
The validator client (VC) is a conceptually separate entity which utilizes private keys to perform validator related tasks, called "duties", on the beacon chain. These duties include the production of beacon blocks and signing of attestations.
The goal of this specification is to promote interoperability between various beacon node implementations.
## Specification
The specification is documented [here](https://ethereum.github.io/beacon-APIs/#/Beacon/getGenesis).
See the Readme [here](https://github.com/ethereum/beacon-apis).