API reference

The DockCrate by BufferSol REST API for an organization: keys, endpoints, errors and rate limits.

Base URL and authentication

All requests go to https://dockcrate.buffersoltech.com/api/v1 over HTTPS and need an x-api-key header. Bodies and responses are JSON.

GET /api/v1/me

Returns the organization the API key belongs to. Use it to check that a key works.

json

{
  "orgId": "org_123"
}

Audit log

GET /api/audit returns the 50 most recent audit entries for your organization, newest first. Pass before with an ISO date to page back. It needs a signed in session with audit read access. Endpoints for tenants, apps and rings are planned.

Errors

Errors use a matching HTTP status and a JSON body with a stable snake case code. Match on the code, not on the status text.

json

{
  "error": "invalid_api_key"
}

Rate limits

Each API key can make 600 requests per minute. Beyond that you get a 429 status with the error code rate_limited. Wait for the next minute and retry with exponential backoff.

Account export and deletion

GET /api/account/export returns a JSON copy of your account data. DELETE /api/account permanently deletes your account and organization. Both require a signed in session and are also available in Settings, then Account.