REST API

Arctickey exposes a small API-key authenticated REST API for EU-hosted Valkey instances.

Create an API key in Dashboard → Settings → API Keys. Store the secret once; only the prefix is shown later. API keys are hashed at rest and can be scoped per use case.

Authentication#

Send the key as a Bearer token:

Terminal

curl https://arctickey.com/api/v1/instances \
  -H "Authorization: Bearer ak_eu_..."

Scopes#

Scope	Allows
`instances:read`	List instances
`instances:wake`	Wake sleeping free-tier instances
`metrics:read`	Read stored metrics
`backups:read`	List backup records

Endpoints#

List Instances#

HTTP

GET /api/v1/instances

Required scope: instances:read

Returns instance status, plan, EU region, billing state, and free-tier sleep metadata.

Wake Instance#

HTTP

POST /api/v1/instances/{id}/wake

Required scope: instances:wake

Wakes a sleeping free-tier instance. The action is written to the customer audit log.

Read Metrics#

HTTP

GET /api/v1/instances/{id}/metrics?limit=100

Required scope: metrics:read

Returns recent memory, connection, command, keyspace hit/miss, and latency samples. limit is capped at 500.

List Backups#

HTTP

GET /api/v1/instances/{id}/backups

Required scope: backups:read

Returns backup status, trigger, size, duration, retention expiry, and error information.