Opidocs
Settings

Developer API

Create workspace API keys and monitor your API usage with rate limits and request quotas.

The Developer API gives your applications programmatic access to your Opisense workspace. Create API keys, monitor usage, and manage rate limits.

Access these settings from Settings > Developer > API.

Creating API keys

Click Create Key to generate a new workspace API key. Each key has:

  • A name to help you identify its purpose (e.g., "Production Backend" or "CI Pipeline")
  • A key value shown once at creation — copy it immediately, as it won't be displayed again

Rate limits

Every workspace has rate limits to ensure fair usage:

LimitWhat it controls
Daily requestsMaximum number of API calls per day
Monthly requestsMaximum number of API calls per month

Progress bars show your current usage against these limits. When you approach a limit, consider optimizing your API calls or contacting support to increase your quota.

Managing keys

From the API keys list, you can:

  • View all active keys and their creation dates
  • Revoke a key that's no longer needed or may be compromised
  • Create additional keys for different applications or environments

API keys have full workspace access. Treat them like passwords — don't commit them to version control or share them in public channels.

On this page