Skip to content

API keys

API keys let an approved agent or automation call supported Eclipse APIs without a browser session. Each key belongs to one organization and one creating user.

Open Settings → API Keys, choose Create key, then select the smallest scopes the integration needs and an expiration date. Creating a key requires both Settings edit and Team manage access.

Eclipse shows the full eclk_… secret once. Copy it directly into a secret manager. Do not place it in source code, screenshots, support tickets, or client-side environment variables.

Send the key as a bearer credential:

Authorization: Bearer eclk_your_key

A key stops authenticating when it is revoked, expires, or its creator no longer has an active seat with Settings edit and Team manage access in the organization. Revocation is limited to the creator’s key in the active organization and takes effect immediately.

If an automation no longer needs access, revoke the key instead of leaving it unused. Create a replacement key before changing production automation credentials, verify the replacement, and then revoke the old key.