Skip to navigation
IntegrationsConnections

Create Connection

Create a new connection.

This will validate the credentials with the TSP before creating the connection. If the credentials are invalid, the connection will not be created and an error will be returned.

It also creates a schedule to refresh or exchanged the coneection details for a short lived credential, shuch as an access token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
tsp_idstringRequiredformat: "uuid"

The ID of the Telematics Service Provider (TSP) that the fleet uses.

credentialsobjectRequired
The connection credentials required to authenticate with the TSP on behalf of the fleet.
descriptionstring or nullOptional
A description of the connection. Useful when the fleet has multiple accounts with the same TSP.

Response

Successful Response
idstringformat: "uuid"
Unique identifier for the connection.
created_atdatetime
Timestamp when the connection was created.
updated_atdatetime
Timestamp when the connection was last updated.
fleet_idstring or nullformat: "uuid"
The Catena ID of the fleet that owns this connection.
tsp_idstringformat: "uuid"

The ID of the Telematics Service Provider (TSP).

source_nameenum
The name of the TSP integration used for this connection.
credentialsobject
The connection credentials used to authenticate with the TSP.
statusenum
The current status of the connection.
descriptionstring or null
A description of the connection. Useful when the fleet has multiple accounts with the same TSP.
fleet_refstring or nullOptional
The reference of the fleet in the partner's system

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error