SkimmerDB Docs
API reference

Meta

Health and this document.

Kept in this tab only and sent only to api.skimmerdb.com. Requests run against your account and count as usage. Make a key.

Health check

GET /healthz no key

Status codes

200OK
curl -s https://api.skimmerdb.com/healthz
from skimmerdb import SkimmerDB
from skimmerdb._api.api.meta import health

db = SkimmerDB()  # SKIMMERDB_KEY
answer = health.sync(client=db.api)
import { SkimmerDB } from "skimmerdb";
import { health } from "skimmerdb/api";

const db = new SkimmerDB(); // SKIMMERDB_KEY
const { data } = await health({ client: db.client });
200 answer
"ok"

This document (OpenAPI 3.1, JSON)

GET /openapi.json no key

Status codes

200OK
curl -s https://api.skimmerdb.com/openapi.json
from skimmerdb import SkimmerDB
from skimmerdb._api.api.meta import get_openapi

db = SkimmerDB()  # SKIMMERDB_KEY
answer = get_openapi.sync(client=db.api)
import { SkimmerDB } from "skimmerdb";
import { getOpenapi } from "skimmerdb/api";

const db = new SkimmerDB(); // SKIMMERDB_KEY
const { data } = await getOpenapi({ client: db.client });