Skip to content

Commit

Permalink
Add API endpoint usage examples
Browse files Browse the repository at this point in the history
  • Loading branch information
rolandtyler committed Jan 11, 2022
1 parent cf12607 commit 184499f
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/Reference/Rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,33 @@ The default location is `http://localhost:9000/swagger-ui`.

You can also use tools such as [Postman] or [cURL] to interact with Web3Signer APIs.

## Endpoint example usage

### `/api/v1/eth2/publicKeys`

Returns the ETH2 BLS public keys for the private keys that have been loaded into Web3Signer.

### `/api/v1/eth2/sign/{identifier}`

Signs data for the ETH2 BLS public key specified as part of the URL and returns the signature.

### `/eth/v1/keystores`

Lists all validating public keys known to and decrypted by this keymanager binary

### `/reload`

Reloads signer keys asynchronously.
This is used after adding new keys to a current set of validators.
The call reloads the keys and makes Web3signer aware of the change.
Not used by validator clients

### `/upcheck`

Checks the Web3Signer server status.
Confirms if Web3Signer is connected and running.
Not used by validator clients

<!-- Links -->
[REST API documentation]: https://consensys.github.io/web3signer/
[Postman]: https://www.postman.com/
Expand Down

0 comments on commit 184499f

Please sign in to comment.