Skip to Content
API ReferenceOverview

API Reference

The Norrix API provides programmatic access to build, submit, and update operations.

Base URLs

EnvironmentBase URL
Productionhttps://norrix.net/api
Developmenthttps://dev.norrix.dev/api

Endpoints

Build Operations

MethodEndpointDescription
GET/buildList builds
GET/build?id={buildId}Get specific build
POST/buildCreate new build
DELETE/build?id={buildId}Delete build

Submit Operations

MethodEndpointDescription
GET/submitList submissions
GET/submit?id={submitId}Get specific submission
POST/submitCreate new submission
DELETE/submit?id={submitId}Delete submission

Update Operations

MethodEndpointDescription
POST/updateCreate OTA update
GET/update/check/{bundleId}Check for updates (public)

Configuration

MethodEndpointDescription
GET/envList environment variables
POST/envSet environment variable
DELETE/env?id={envId}Delete environment variable
GET/api-keysList API keys
POST/api-keysCreate API key
DELETE/api-keys?id={keyId}Revoke API key
GET/webhooksList webhooks
POST/webhooksCreate webhook
PUT/webhooksUpdate webhook
DELETE/webhooks?id={webhookId}Delete webhook

Authentication

All endpoints except /update/check require authentication.

See Authentication for details.

Response Format

Success Response

{
  "id": "build-1234567890",
  "status": "success",
  "...": "..."
}

Error Response

{
  "error": "Unauthorized",
  "message": "Invalid or expired API key"
}

HTTP Status Codes

CodeMeaning
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Internal Error

Rate Limits

API requests are rate limited:

TierLimit
Free60 requests/minute
Pro300 requests/minute
Enterprise1000 requests/minute

Rate limit headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1704067200

Pagination

List endpoints support pagination:

ParameterDefaultDescription
limit10Number of items (max 100)
offset0Skip this many items

Example:

GET /api/build?limit=20&offset=40

SDK Access

The Client SDK uses the public OTA check endpoint:

GET /api/update/check/{bundleId}

See OTA Check API for details.

Billing & UsageAuthentication