Updated on November 12, 2020
Enable the REST API service from the command line. You can also interact with APIs using Swagger UI by enabling the API documentation endpoint.
View the REST API documentation for more information about the available APIs.
Enable the REST API service
Enable the REST API service by setting the
command line option to
Only trusted parties should access the REST API. Do not directly expose these APIs publicly on production nodes.
Interact with Teku APIs using the web browser by setting the
--rest-api-docs-enabled command line option to
Access the APIs at
The default location is
curl -X GET "http://localhost:5051/beacon/committees?epoch=2"
REST API endpoints
The REST API is logically divided into multiple endpoints.
|/admin||Provides network administration functionality.|
|/beacon||General information about the beacon chain.|
|/network||Information about the network.|
|/node||Information about the beacon node.|
|/validator||Provide information and functionality for validator clients.|