Files
lighthouse/book/src/api-vc-auth-header.md
chonghe 3c1266e41c Remove VC response signing and update api-token in Lighthouse Book (#6288)
* update api-token

* Update book/src/api-vc-auth-header.md

Co-authored-by: Michael Sproul <micsproul@gmail.com>

* Update book/src/api-vc-auth-header.md

Co-authored-by: Michael Sproul <micsproul@gmail.com>

* Update book/src/api-vc-endpoints.md

Co-authored-by: Michael Sproul <micsproul@gmail.com>

* Update book/src/api-vc-endpoints.md

Co-authored-by: Michael Sproul <micsproul@gmail.com>

* Remove 33 characeter
2024-08-22 06:51:59 +00:00

65 lines
1.6 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`. 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"}}
```