None of these endpoints need an API key.

GET /status#

Returns information about the server which answers the request, and about the other servers it knows. We use this to watch the health of the cluster. The fields are not described here because they change when the software changes.

A status of 200 means that the API and its database work.

GET /misc/cluster_speed#

Returns how much data Nova is sending and receiving at the moment, in bytes per second.

curl https://nova.storage/api/misc/cluster_speed
{
	"server_tx": 7161697,
	"server_rx": 2584752,
	"cache_tx": 7161697,
	"cache_rx": 2584752,
	"storage_tx": 13481931,
	"storage_rx": 5682464
}

tx is sent and rx is received. server is the server which answers the request, cache is all servers which talk to users and storage is all servers which store files.

GET /misc/speedtest#

Sends random data, to measure the download speed of a connection.

Parameter Required Value
limit no Number of bytes to send. The default is 1000000000, 1 GB
curl -o /dev/null "https://nova.storage/api/misc/speedtest?limit=100000000"

GET /misc/qr#

Returns a QR code as a PNG image of 512 by 512 pixels.

Parameter Required Value
text yes What to put in the QR code, up to 2048 characters
curl -o qr.png "https://nova.storage/api/misc/qr?text=https%3A%2F%2Fnova.storage"