Skip to main content
Version: 1.1.0

Eixam Backend API

Server-to-server API. Every token belongs to exactly one Eixam app; app identity is derived only from the bearer token. Tokens are created in Portal under Credentials and usage, shown once, and cannot be retrieved later.

All authenticated attempts consume the app-wide request-per-minute quota and are metered for estimated usage reporting, including rate-limited attempts. A 429 response includes Retry-After; invalid authentication attempts cannot be attributed to an app. Authentication, rate limiting, and usage accounting fail closed with 503 when their required storage is unavailable.

Every submitted telemetry event also consumes the app-wide event-per-minute quota, including invalid, conflicting, and replayed events. A zero request or event quota means unlimited. Batch telemetry bodies are limited to 8 MiB and 500 events. Telemetry/user single-write bodies are limited to 128 KiB, search bodies to 32 KiB, and device-link bodies to 16 KiB. User metadata and telemetry payloads are limited to 64 KiB each; metadata/payload search filters are limited to 8 KiB. Limits are measured from the encoded JSON received by the API.

Authentication

Opaque token shown once when created in Portal.

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

eixam_api_CREDENTIAL_UUID_SECRET