Skip to main content

Authentication & Security

API Keys

Settler uses API keys to authenticate requests. You can create and manage API keys in the Console.

Using API Keys

import { Settler } from '@settler/sdk';

const client = new Settler({
  apiKey: process.env.SETTLER_API_KEY, // Never hardcode keys!
});

⚠️ Security Best Practices:

  • Never commit API keys to version control
  • Use environment variables or secret management
  • Rotate keys regularly
  • Use different keys for development and production
  • Revoke compromised keys immediately

Workspace Scoping

All API requests are automatically scoped to your workspace. You can only access resources within workspaces where you have membership.

Rate Limiting

API requests are rate-limited per workspace. See Status & Limits for current limits.