API Reference

The Haltless REST API provides programmatic access to all platform features. This reference documents every endpoint, request/response schema, and authentication requirement.

Base URL

https://api.haltless.io/api/v1

API version

The current API version is v1. All endpoints are prefixed with /api/v1/.

v1

Authentication

Most endpoints require authentication via one of:

Method	Header	Use case
JWT Bearer	Authorization: Bearer <token>	Interactive users, dashboards
API Key	X-API-Key: <key>	Edge agents, automation

See Authentication for details.

Request format

• Content-Type: application/json for all request bodies
• Character encoding: UTF-8
• Timestamps: ISO 8601 format in UTC (e.g., 2026-04-04T10:30:00Z)
• UUIDs: All resource IDs are v4 UUIDs

Response format

All responses return JSON with appropriate HTTP status codes:

Code	Meaning
200	Success
201	Created
204	No content (successful delete)
207	Multi-status (batch operations)
400	Bad request (validation error)
401	Unauthorized
402	Payment required
403	Forbidden (insufficient role)
404	Not found
409	Conflict (duplicate resource)
422	Unprocessable entity
429	Rate limit exceeded
500	Internal server error

Pagination

List endpoints support pagination:

Parameter	Type	Default	Max
page	integer	1	-
page_size	integer	20	100

Response includes pagination metadata:

{
  "items": [...],
  "total": 150,
  "page": 1,
  "page_size": 20,
  "total_pages": 8
}

Rate limiting

Every response includes rate limit headers:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 298

When exceeded, you'll receive 429 with:

Retry-After: 12
X-RateLimit-Reset: 1712234567

See Rate Limiting for tier-specific limits.

Endpoint catalog

Core Resources

Endpoint	Description
/machines	Register and manage your machine fleet
/machines/{id}/readings	Ingest and query sensor time-series
/alerts	Threshold alerts and acknowledgment
/alert-rules	Configure alert thresholds

Operations

Endpoint	Description
/maintenance	Maintenance event scheduling
/work-orders	Work order lifecycle management
/machines/{id}/downtime	Downtime tracking and analysis
/oee	Overall Equipment Effectiveness
/shifts	Shift definitions and logging
/work-orders/{id}/signoffs	Digital sign-off and compliance
/inventory	Spare parts and stock management

Intelligence

Endpoint	Description
/fleet	Fleet status, site KPIs, cross-site comparison
/machines/{id}/prediction	AI-powered RUL and anomaly detection
/reports	PDF/CSV report generation

Integration

Endpoint	Description
/erp	SAP, Dynamics 365, Oracle integration
/notification-channels	Email, Slack, Teams, webhook notifications
/ws/dashboard	Real-time WebSocket streaming

Administration

Endpoint	Description
/settings	API keys, permissions, AI config
/audit	Audit trail for all actions
/billing	Subscription and checkout management