> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# DeployHQ plugin

> Manage DeployHQ accounts, projects, servers, deployments, configuration, users, and deployment resources through its documented REST API.

Use **DeployHQ** through Corsair: one client, typed API calls.

Configure the account permalink with the api\_key account field account\_subdomain or the accountSubdomain plugin option. Authenticated calls use HTTP Basic with the DeployHQ email/username and API key; save the key as Corsair api\_key auth and set username in the api\_key account fields or plugin option. The API key alone is insufficient. For clients without a database or KEK, provide key, username, and accountSubdomain directly in plugin options and keep credentials in a secret manager. The API guide documents a 40-character API key but no OAuth 2 flow. The OpenAPI document enumerates 216 REST operations, all linked in the package README. Public routes do not send credentials. Writes are not retried; safe GETs use the shared HTTP transport and honor numeric-seconds Retry-After values. The shared transport does not parse HTTP-date Retry-After on JSON routes; fixing that requires shared-core scope. Invoice downloads parse both forms locally. No undocumented pagination or rate limits are assumed. The signup operation posts to `https://api.deployhq.com/api/v1/signup`, so it does not require an existing account subdomain. The [signup guide](https://www.deployhq.com/support/api/signup) shows `https://deployhq.com/api/v1/signup`, but that host answers 301 to [www.deployhq.com](http://www.deployhq.com), which returns 404. SVG status badges are returned as text strings. No inbound webhook contract is documented or implemented.

**What you get:**

* 216 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/deployhq better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/deployhq better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/deployhq better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/deployhq better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { deployhq } from '@corsair-dev/deployhq';

export const corsair = createCorsair({
	plugins: [
		deployhq(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the DeployHQ API key before the first call: `pnpm corsair setup --plugin=deployhq --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> deployhq()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'deployhq',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**`account.billingStatusAccountBillingStatus`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.deployhq.api.account.billingStatusAccountBillingStatus({});
```

**Update account settings**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.deployhq.api.account.replaceAccount({
	body: {
		account: {},
	},
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/deployhq/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/deployhq/api.md)
>
> Every `deployhq.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.