Base URL
All API requests are made against the backend host you deploy. In local development this ishttp://localhost:3000; in production it’s whatever hostname you expose the Node backend behind (typically https://api.<your-domain>).
/api/. Agent-facing endpoints served by the Go Collector live under a separate host — usually https://collector.<your-domain> — and are documented in Agents.
Conventions
All responses are JSON, all timestamps are ISO 8601 in UTC, and every request/response body uses camelCase field names.
- Request bodies for
POST,PUT,PATCH:application/json(unless documented otherwise, e.g. certificate downloads returnapplication/x-pem-file). - Response bodies:
application/json.
/api/iot/* endpoints) return raw objects without the data wrapper. Those are called out inline on each page.
Workspace context
TigerTrust is multi-tenant. Every resource — certificates, CAs, agents, workflows — belongs to a workspace. When you authenticate with a session cookie, your active workspace is inferred from the session user’scurrentWorkspaceId. You can override it per-request with the X-Workspace-Id header, provided the user is a member of the target workspace.
X-Workspace-Id.
Authentication
Three mechanisms are supported. See Authentication for the full flow.Session cookies
Browser-based login via
/api/auth/login (email + password) or Google OAuth. Sets a connect.sid cookie.API keys
Long-lived
ck_... (public) or ak_... (agent) tokens. Sent via the X-API-Key header or Authorization: Bearer.OAuth 2.0
Google identity federation for interactive sign-in via
/api/auth/google.Rate limiting and pagination
List endpoints default to 50 items per page with a hard cap of 100. Use?page= and ?limit= (or ?offset= and ?limit=) — see Pagination and errors.
Client examples
See also
- Authentication — how to obtain and use credentials
- Pagination and errors — response envelopes and status codes
- Certificates — the most-used resource
- Agents — collector-facing endpoints for field agents