Overview

• update on a list replaces it. services.envVars.update, services.secretFiles.update, services.headers.update, services.routes.update, buildSources.envVars.update and buildSources.secretFiles.update take the full list as body, and entries not in the list are removed. To change one entry, use the matching upsert (for example services.envVars.upsert or services.envGroups.envVars.upsert).
• Secrets come back in plain text. Env var and secret file reads return values and file contents.
• Paging. Lists return an array of { cursor, <resource> } entries. Pass the last entry’s cursor to get the next page; limit goes up to 100.
• Rate limits. On a 429 the plugin waits for Render’s Retry-After (at most 60 seconds) and retries up to five times.
• Not covered. The deprecated /redis routes (use the Key Value operations), sandboxes, flows, and the streaming endpoints (log subscribe and task-run events). The plugin does not receive webhooks; webhooks.create and friends manage Render’s outgoing webhooks.

• 218 typed API operations
• 1 synced entity (renderOwner) for fast .search() / .list()

​

Setup

npm install corsair @corsair-dev/render

yarn add corsair @corsair-dev/render

pnpm install corsair @corsair-dev/render

bun add corsair @corsair-dev/render

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { render } from '@corsair-dev/render';

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

render()

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

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.render.api.services.list({
	type: ['web_service'],
	region: ['oregon'],
	limit: 20,
});

const tenant = corsair.withTenant('acme');
await tenant.render.api.services.triggerDeploy({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9' });

​

Query synced data

const tenant = corsair.withTenant('acme');
const rows = await tenant.render.db.renderOwner.search({
	data: { name: 'Acme' },
	limit: 50,
});

​

What’s next