v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Data Management

Raw Passthrough

Make an authenticated request to the underlying telematics provider and forward successful provider response bodies directly.

Use Raw Passthrough for provider endpoints that download inspection photos, documents, videos, or other non-JSON files.

Response rules:

  • Provider success (2xx): the provider body is returned as raw bytes with the provider's Content-Type and status.
  • Provider error (non-2xx): the response is HTTP 200 with a PassthroughOutput JSON envelope (statusCode, headers, response), matching /passthrough. Unsuccessful provider responses are therefore not surfaced as Terminal API errors; check the envelope's statusCode for the provider status.
  • Terminal error: requests that fail before or around the provider call return a standard Terminal error status and JSON body.

For normal JSON API calls where you want Terminal to parse and wrap successful provider responses too, use /passthrough instead.

post/passthrough/raw

Headers

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

The token returned when a user authenticated their account. This authorizes access to a specific account.

Request body

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' required

The method for the third-party request, such as GET or POST.

pathstring required

The path for the third-party request, such as /reports

headersobject

The headers to use for the request (Terminal will handle the connection's authorization headers)

bodystring

The request body

Example request

{
  "method": "POST",
  "path": "/reports",
  "body": "{\"reportId\":\"1234\"}"
}

Response

A successful provider response body, forwarded directly without the Terminal PassthroughOutput JSON envelope. The Content-Type reflects the provider's response (for example image/jpeg or application/pdf), not necessarily application/octet-stream.