QumoClient

​

QumoClient

const client = new QumoClient({
  baseUrl: "https://api.qumo.example.com",
  token: "your-admin-token",
});
const list = await client.projects.list();

new QumoClient(config: QumoConfig)

​

Namespaces

• client.auth — Sessions, sign-in, two-factor auth, personal tokens and the account.
• client.tenants — Workspaces: listing, settings, usage and invoices.
• client.projects — Projects, their usage, budgets, alerts and connection limits.
• client.apiKeys — Project API keys, their usage and IP allowlists.
• client.audit — Audit log and the audit webhook.
• client.iam — IAM role bindings and built-in roles.
• client.invitations — Invitations to join a workspace.
• client.notifications — Notification policies.
• client.identities — Machine identities and their tokens.
• client.credentials — Relay credentials and the keys that verify them.
• client.pricing — Plans, SKUs and published pricing.
• client.ipAllowlists — IP allowlists for machine identities.
• client.paymentMethods — Saved payment methods.
• client.billing — Billing summary, checkout and the billing portal.

​

request

request<T>(path: string, options?: RequestInit): Promise<T>

​

requestRaw

requestRaw(path: string, options?: RequestInit): Promise<Response>

​

QumoConfig

• baseUrl string — The control plane’s base URL, e.g. https://api.qumo-deploy.com. An empty string makes requests relative to the current origin (browser use).
• token? string — Bearer token sent as Authorization: Bearer …. Takes precedence over apiKey.
• apiKey? string — API key sent as X-API-Key, used when no token is set.
• csrfToken? () => string | null | undefined — Supplies the CSRF token for cookie-authenticated (browser session) calls. The server requires X-CSRF-Token on every mutating request made with the qumo_session cookie; Bearer/API-key callers are exempt and can omit this. Called per request so a rotated token is picked up without rebuilding the context. Returning null/undefined sends no header.

​

APIError

new APIError(status: number, message: string, data?: unknown)

• status — The HTTP status code.
• message — The server’s error message.
• data — The parsed response body, or its raw text when it is not JSON.