Skip to main content

Authentication

All requests to the Zentari Axis API must be authenticated using an API key. API keys are issued per tenant and can be managed from the Axis Platform dashboard.

API Key​

Include your API key in every request using the x-api-key header:

x-api-key: YOUR_API_KEY

Example Request​

GET /api/sims HTTP/1.1
Host: app.zentarinetworks.com
x-api-key: YOUR_API_KEY
Accept: application/json

Obtaining an API Key​

  1. Log in to the Axis Platform
  2. Navigate to Settings → API Keys
  3. Generate and copy your key — store it securely
caution

Never expose your API key in client-side code, public repositories, or logs. Treat it with the same care as a password.

Error Codes​

Authentication failures return standard HTTP status codes:

CodeMeaning
401 UnauthorizedMissing or invalid API key
403 ForbiddenValid key but access denied

All error responses use the following shape:

{
  "status": "Unauthorized",
  "error_code": 401,
  "error_message": "Invalid or missing API key"
}