Connections / API reference

Connection health

Read the authorized fleet connection's identity and collection health.

GET/v1/connections/{id}

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

Map your application's tenant to customer_id and explicitly granted connections; an ID alone never grants access.
last_success_at is collection time, not the observation time of each reading.
extended_last_error_code and extended_next_retry_at describe optional collection separately. Consult them when extra readings stay missing or stale.

Parameters

Name	Where	Required	Type and behavior
`id`	path	Yes	`string`

Request example

bash

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

Response fields

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

Field	Type	Required
`id`	`string`	Yes
`customer_id`	`string`	Yes
`provider`	`string`	Yes
`last_success_at`	`string \| null`	No
`last_error_code`	`string \| null`	No
`extended_last_success_at`	`string \| null`	No
`extended_last_error_code`	`string \| null`	No
`extended_next_retry_at`	`string \| null`	No

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

{
  "id": "10000000-0000-4000-8000-000000000001",
  "customer_id": "example-customer",
  "provider": "example-provider",
  "last_success_at": "2026-10-01T00:00:00Z",
  "last_error_code": null,
  "extended_last_success_at": "2026-10-01T00:00:00Z",
  "extended_last_error_code": null,
  "extended_next_retry_at": null
}

Errors and retries

HTTP status	Meaning
`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": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "customer_id": {
      "type": "string"
    },
    "provider": {
      "type": "string"
    },
    "last_success_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "last_error_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "extended_last_success_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "extended_last_error_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "extended_next_retry_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "customer_id",
    "provider"
  ]
}

← API overview · Download OpenAPI