TypeScript SDK Quickstart

The official @qumo-deploy/sdk package provides complete, strongly-typed programmatic control over the Qumo Deploy control plane.

Installation

The SDK is published on JSR. Every package manager installs it from there; the import is @qumo-deploy/sdk either way:

npx jsr add @qumo-deploy/sdk

pnpm dlx jsr add @qumo-deploy/sdk

yarn dlx jsr add @qumo-deploy/sdk

bunx jsr add @qumo-deploy/sdk

deno add jsr:@qumo-deploy/sdk

Client Initialization

Construct an instance of QumoClient by supplying your base URL and credentials:

import { QumoClient } from "@qumo-deploy/sdk";

// Initialize with a personal access token or identity token
const client = new QumoClient({
  baseUrl: process.env.QUMO_BASE_URL || "https://api.qumo-deploy.com",
  token: process.env.QUMO_TOKEN, // e.g. "qumo_pat_..."
});

Authentication Modes

The client supports two authentication contexts:

Bearer Token (token): For scripts and CI/CD. Pass a personal access token (qumo_pat_...) or an identity token. Sends Authorization: Bearer <token>.
Session Cookie + CSRF (csrfToken): For browser code served from the console’s own origin, where the session cookie is present. api.qumo-deploy.com ignores cookies, so use an empty baseUrl (same origin). Pass a callback returning the value of the qumo_csrf_token cookie; the client sends it as X-CSRF-Token on mutating requests:

const browserClient = new QumoClient({
  baseUrl: "",
  csrfToken: () => getCookie("qumo_csrf_token"),
});

First API Call: Fetching Organizations & Projects

This sample needs a personal access token. An identity token belongs to a project, not a user, and listing memberships refuses it with 401.

import { QumoClient } from "@qumo-deploy/sdk";

async function main() {
  const client = new QumoClient({
    baseUrl: "https://api.qumo-deploy.com",
    token: process.env.QUMO_TOKEN,
  });

  // The organizations you belong to. A personal token names no organization,
  // so pick one and pass its id.
  const memberships = await client.auth.getMemberships();
  const organization = memberships[0];
  console.log(`Organization: ${organization.organization_name} (role ${organization.role_id})`);

  // List the projects in that organization
  const projects = await client.projects.list({ organization_id: organization.organization_id });
  console.log(`Found ${projects.length} projects:`);
  for (const p of projects) {
    console.log(` - ${p.name} [${p.environment}] (ID: ${p.id})`);
  }
}

main().catch(console.error);