Skip to content
Dreeve

Overview

The public HTTP API of a self-hosted Dreeve instance.

Dreeve HTTP API v1

Section titled “Dreeve HTTP API v1”

Every endpoint is authenticated with a bearer token and returns JSON. Errors always use the same shape, with a stable error code to branch on and a human readable message.

Enabling the API

The API is closed until DREEVE_API_KEY is set. Generate a key in the admin panel under Settings → Security → API access, put it in your .env file, and recreate your containers

Only a key generated by Dreeve is accepted; it looks like drv_ followed by 64 hex characters. To revoke a key, delete the line and recreate the containers again.

GET /api/v1/status is the cheapest way to check that a URL and key are correct.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/api/v1/status
POST
/api/v1/activity/upload

Authentication

Section titled “Authentication”

apiKey

Section titled “apiKey”

Send your key as Authorization: Bearer drv_...

Security scheme type: http