Skip to main content
The 1eye API uses Bearer API-key authentication. Every API request must include your API key in the Authorization header.

Example request

API keys are scoped to a single 1eye workspace. The API key automatically determines which workspace the request belongs to, so a workspace ID does not need to be included in the API URL.

API key format

Production API keys begin with:
Example:

Using your API key

API keys must:
  • Be passed in the Authorization header
  • Use the Bearer authentication scheme
  • Only be transmitted over HTTPS
API keys must never:
  • Be passed as query parameters
  • Be included in URLs
  • Be written to application logs
  • Be written to API logs
  • Be included in error messages

Authentication errors

If an API key is missing, invalid, or revoked, the API returns:
Example response:

Workspace access

An API key can only access resources that belong to its associated workspace. If a requested resource does not exist or belongs to another workspace, the API returns:
The API does not reveal whether a resource exists in another workspace.

Next step

Create and manage your API keys from the API Keys section.