Connections / API reference

Disconnect a fleet

Disable this connection's local access and collection.

POST/v1/connections/{id}/disconnect

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

Requires management permission; send no request body.
This disables this service's connection. It does not claim to uninstall an upstream app or revoke every grant at the provider.
Existing business records in your product remain your product's responsibility.

Parameters

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

No JSON request body is required.

Request example

bash

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

Response fields

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

Field	Type	Required
`connectionId`	`string`	Yes
`status`	`"disconnected"`	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

{
  "connectionId": "10000000-0000-4000-8000-000000000001",
  "status": "disconnected"
}

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": {
    "connectionId": {
      "type": "string",
      "format": "uuid"
    },
    "status": {
      "const": "disconnected"
    }
  },
  "required": [
    "connectionId",
    "status"
  ]
}

← API overview · Download OpenAPI