Documentation

Authentication

API requests are authenticated via the API key.

As such, it is important that your API key remains secret. Only make requests to K(V)AAS from your backend.

To get your API key, go to the dashboard and click on the "Reveal API key" button.

Usage

To authenticate your requests, add the following header to your requests:

"x-api-key": your api key

Key-Value pairs are scoped by API Keys. Values set under one API key cannot be retrieved by a different API key.

Set Key Value

To set a key value, make a POST request to the following endpoint:

POST https://www.kvaas.cloud/api/{key}

The body of the request should be a JSON object with the following structure:

{ "value": "your value" }

Response

The response will be a string of the value passed in with the request:

"your value"

cURL example

curl -X POST -H "Content-Type: application/json" -H "x-api-key: your api key" -d '{"value":
			"this is a test value"}' https://www.kvaas.cloud/api/testkey

Notes

Keys are limited to 32 characters. Values are limited to 4096 characters.
If the key already exists, the value will be overwritten.
Keys are case sensitive.
Keys are only stored for 1 hour.

Get Key Value

To get a key value, make a GET request to the following endpoint:

GET https://www.kvaas.cloud/api/{key}

Response

The response will be a string of the value for the key:

"your value"

If no value was found for the key, then the response is empty.

cURL example

curl -X GET -H "Content-Type: application/json" -H "x-api-key: your api key"
			https://www.kvaas.cloud/api/testkey