API Keys
OpenMeter uses API keys to authenticate requests to the HTTP API. You can pass
the API key in the Authorization
header of the HTTP request as a Bearer token.
Example:
Authorization: Bearer <api-key>
Create New API Key
You can create a new API key in the OpenMeter Cloud Dashboard:
- Sign in to OpenMeter Cloud (Use organization selector)
- Go API
- Click Create Token
API Key Expiration
When you create a new API key, you can set an optional expiration date for the key. If you don't set an expiration date, the key will never expire.
If you set an expiration date, be sure to track the expiration date of the key and update your services to use the new key. We also recommend setting a calendar event for your developer team to rotate the key before it expires.
API Key Roles
When creating a new API key, you can assign a role to the key. Available roles are:
- Read and Write: Can manage all resources.
- Read Only: Can read all resources.
- Restricted: Fine grained access, see RBAC.