The most common way to interact with the Valo API is via HTTP.
The HTTP transport is enabled by default, and takes advantage of web standards and conventions.
Both HTTP/1.1 and HTTP/2 are supported. HTTP/2 is encouraged where possible so that request multiplexing can minimise the number of TCP connections between the client and Valo.
The embedded HTTP server in Valo has been designed to support the documented API and be as performant as possible.
In some cases, this may be at the expense of full compliance to web standards or protection against attacks.
Don’t expose Valo directly to the internet and please report any problems or standards compliance issues you encounter to firstname.lastname@example.org
The following pages include information about the HTTP headers:
Using the API via your web browser¶
Valo API operations using the
GET verb can be invoked directly from your web browser.
For example if you have Valo running on your machine (and haven’t altered the HTTP configuration) you can get the state of the Valo cluster by browsing to http://localhost:8888/cluster.
This particular operation is described in more detail in the Cluster API documentation.
Alternatives to HTTP¶
HTTP is not the only option for interacting with the Valo API.
We are working on various language specific SDKs which will make interacting with Valo more convenient and idiomatic from your language of choice.
Valo also includes a pluggable transport system. We currently ship with the HTTP transport, we are likely to add others in the future.