API Overview

The Haltless REST API is a JSON-over-HTTPS interface for registering machines, ingesting sensor telemetry, and managing alerts, maintenance, work orders, downtime, and OEE. This reference documents every public endpoint, its request parameters, and its response shape.

Base URL

All requests are made to:

https://api.haltless.io

Every endpoint in this reference is versioned under the /api/v1 prefix. For example, the machines collection is:

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

Throughout the rest of this reference, paths are written in their short form (for example `/api/v1/machines`).

Authentication

Most endpoints require a bearer JWT:

Authorization: Bearer <jwt>

Telemetry ingestion at `POST /api/v1/ingest` uses an API key instead:

X-API-Key: <api-key>

See Authentication for how to obtain and refresh tokens, and the API Keys guide for issuing ingestion keys.

Request format

• Content-Type: send application/json for all request bodies.
• Character encoding: UTF-8.
• Timestamps: ISO 8601 in UTC (for example 2026-08-07T10:30:00Z).
• Identifiers: resource IDs are UUIDs.

Response format

Responses are JSON. Successful requests return one of:

Code	Meaning
200	Success
201	Resource created
204	Success with no body (for example a delete)
207	Multi-status (batch ingestion)

See Errors for the full list of error codes and the error body shape.

Pagination

Collection endpoints that page use the following query parameters:

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

Paginated responses wrap the results in an items array alongside a pagination object:

{
  "items": [],
  "pagination": {
    "total": 150,
    "page": 1,
    "page_size": 20
  }
}

Rate limiting

Limits are uniform for every account and depend only on the kind of request. See Rate Limiting for the exact budgets and the response headers.

Endpoint catalog

Resource	Description
Machines	Register and manage machines, groups, tag mappings, and units
Sensor Data	Ingest telemetry and query time-series readings
Alerts	List, acknowledge, snooze, and comment on alerts
Alert Rules	Configure threshold, composite, and escalation rules
Maintenance	Schedule and track maintenance events
Work Orders	Manage work orders, instructions, and attachments
Downtime	Record downtime, reason codes, and reliability KPIs
OEE	Submit and summarize Overall Equipment Effectiveness