Faults / API reference

Active faults

Read current open fault occurrences across the connection.

GET/v1/connections/{id}/faults

Authentication: Bearer consumer API key with an explicit connection grant.

Preview contract. Availability depends on the deployed release, authorized connection and asset.

How to use this endpoint

Returns up to 100 faults. Pass nextCursor as after until it is null.
An occurrence ID identifies one open-to-clear lifecycle; the same fault code can recur with a new occurrence ID.
bootstrap:true marks a fault first seen during initial observation. It is existing evidence, not proof of a newly developing fault.
An absent diagnostic report never clears a fault.

Parameters

Name	Where	Required	Type and behavior
`id`	path	Yes	`string`
`after`	query	No	`string` Fault occurrence cursor from nextCursor.

Request example

bash

curl "$TELEMATICS_ORIGIN/v1/connections/$CONNECTION_ID/faults" \
  --header "Authorization: Bearer $TELEMATICS_CONSUMER_KEY"

Response fields

HTTP 200 returns Faults. Fields listed as required are guaranteed by this contract; optional fields may be absent.

Field	Type	Required
`faults`	`Fault[]`	Yes
`nextCursor`	`string \| null`	Yes

Nested field shapes and constraints are defined in the OpenAPI contract. For latest telemetry values, see normalized units and availability.

Response example

Synthetic values; this is a shape example, not a live customer response.

json

{
  "faults": [
    {
      "id": "20000000-0000-4000-8000-000000000002",
      "vehicle_id": "asset-001",
      "fault_key": "example:P0100",
      "code": "P0100",
      "description": "Example diagnostic",
      "opened_at": "2026-10-01T00:00:00Z",
      "bootstrap": true
    }
  ],
  "nextCursor": null
}

Errors and retries

HTTP status	Meaning
`400`	Invalid time window, metric or cursor
`401`	Consumer authentication denied
`404`	Resource missing or connection access denied
`503`	Service or database unavailable

Errors return {"error":"reason_code"}. Honor Retry-After when a 429 includes it. Permission and provider failures never become zero-valued telemetry. Connection health and reading status provide separate signals.

Response schema

{
  "type": "object",
  "properties": {
    "faults": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Fault"
      }
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "faults",
    "nextCursor"
  ]
}

← API overview · Download OpenAPI