mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-10 04:01:51 +00:00
11e1d5bf14
* Add cli flag for HTTP API token path (VC) * Add http_token_path_flag test * Add pre-check for directory case & Fix test utils * Update docs * Apply review: move http_token_path into validator_http_api config * Lint * Make diff lesser to replace PK_FILENAME * Merge branch 'unstable' into feature/cli-token-path * Applt review: help_vc.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Fix help for cli * Fix issues on ci * Merge branch 'unstable' into feature/cli-token-path * Merge branch 'unstable' into feature/cli-token-path * Merge branch 'unstable' into feature/cli-token-path * Merge branch 'unstable' into feature/cli-token-path
66 lines
1.7 KiB
Markdown
66 lines
1.7 KiB
Markdown
# Validator Client API: Authorization Header
|
|
|
|
## Overview
|
|
|
|
The validator client HTTP server requires that all requests have the following
|
|
HTTP header:
|
|
|
|
- Name: `Authorization`
|
|
- Value: `Bearer <api-token>`
|
|
|
|
Where `<api-token>` is a string that can be obtained from the validator client
|
|
host. Here is an example of the `Authorization` header:
|
|
|
|
```text
|
|
Authorization: Bearer hGut6B8uEujufDXSmZsT0thnxvdvKFBvh
|
|
```
|
|
|
|
## Obtaining the API token
|
|
|
|
The API token is stored as a file in the `validators` directory. For most users
|
|
this is `~/.lighthouse/{network}/validators/api-token.txt`, unless overridden using the
|
|
`--http-token-path` CLI parameter. Here's an
|
|
example using the `cat` command to print the token to the terminal, but any
|
|
text editor will suffice:
|
|
|
|
```bash
|
|
cat api-token.txt
|
|
hGut6B8uEujufDXSmZsT0thnxvdvKFBvh
|
|
```
|
|
|
|
When starting the validator client it will output a log message containing the path
|
|
to the file containing the api token.
|
|
|
|
```text
|
|
Sep 28 19:17:52.615 INFO HTTP API started api_token_file: "$HOME/holesky/validators/api-token.txt", listen_address: 127.0.0.1:5062
|
|
```
|
|
|
|
The _path_ to the API token may also be fetched from the HTTP API itself (this endpoint is the only
|
|
one accessible without the token):
|
|
|
|
```bash
|
|
curl http://localhost:5062/lighthouse/auth
|
|
```
|
|
|
|
Response:
|
|
|
|
```json
|
|
{
|
|
"token_path": "/home/karlm/.lighthouse/holesky/validators/api-token.txt"
|
|
}
|
|
```
|
|
|
|
## Example
|
|
|
|
Here is an example `curl` command using the API token in the `Authorization` header:
|
|
|
|
```bash
|
|
curl localhost:5062/lighthouse/version -H "Authorization: Bearer hGut6B8uEujufDXSmZsT0thnxvdvKFBvh"
|
|
```
|
|
|
|
The server should respond with its version:
|
|
|
|
```json
|
|
{"data":{"version":"Lighthouse/v0.2.11-fc0654fbe+/x86_64-linux"}}
|
|
```
|