Skip to content

Keymanager API

Warning

This feature is currently in BETA - we are still testing it and implementation details may change in response to community feedback. We strongly advise against using it on mainnet - your validators may get slashed

The standardized Keymanager API can be used to add, remove, or migrate validators on the fly while the beacon node is running.

As of v1.7.0 it supports web3signer keystores.

Configuration

By default, we disable the Keymanager API. To enable it, start the beacon node with the --keymanager option enabled:

./run-prater-beacon-node.sh --keymanager

Once the node is running, you'll be able to access the API from http://localhost:5052/

Authorization: Bearer scheme

All requests must be authorized through the Authorization: Bearer scheme with a token matching the contents of a file provided at the start of the node through the --keymanager-token-file parameter.

Enabling connections from outside machines

By default, only connections from the same machine are entertained. If you wish to change this you can configure the port and listening address with the --keymanager-port and --keymanager-address options respectively.

Warning

The Keymanager API port should only be exposed through a secure channel (e.g. HTTPS, an SSH tunnel, a VPN, etc.)

Specification

The specification is documented here. The README is also extremely useful and is documented here.