Organization API Keys

Organization API keys let you deploy and manage sites programmatically — ideal for CI/CD pipelines, scripts, and automation.

Key format

Organization API keys use the org_ prefix:

org_abc123def456...

This prefix distinguishes them from personal API keys and automatically scopes all operations to the organization.

Who can create keys

Only owners and admins can create and revoke organization API keys. Members cannot manage keys.

Creating a key

1. Navigate to your organization's Keys page
2. Click Create Key
3. Copy the key immediately — it won't be shown again

Using in CI/CD

Set your organization API key as an environment variable. The CLI detects the org_ prefix and automatically scopes deploys to the correct organization.

GitHub Actions

name: Deploy
on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    env:
      SAMPLEX_API_KEY: ${{ secrets.ORG_API_KEY }}
    steps:
      - uses: actions/checkout@v4
      - run: npm ci && npm run build
      - run: npx samplex deploy ./dist

Other CI providers

Set SAMPLEX_API_KEY as a secret environment variable in your CI provider's settings, then run npx samplex deploy ./dist in your pipeline.

Permission scopes

Organization API keys have access to these operations:

Rate limiting

Organization API keys are rate-limited to 120 requests per 5 minutes. If you exceed this limit, requests return a 429 Too Many Requests response.

Finding your Organization ID

Your Organization ID is displayed at the top of the Keys page in your organization dashboard. You need this ID when using the CLI with the --org flag.

Revoking keys

1. Go to the Keys page
2. Find the key you want to revoke
3. Click Revoke

Revoked keys stop working immediately. Any CI/CD pipelines using the key will fail until updated with a new key.