Powered by Redocly

Connectors

Manage the connectors of your customers.

Connector

A connector is a hardware device that enables you to communicate with a vehicle of the customer. A customer's connector is also known as a 'remote'.

id
string <uuid>

Connector identifier.

customer_id
string or null <uuid>

Reference to customer to which the connector is assigned.

hardware_version
string

A connector's hardware version.

name
string

Human-readable connector identifier.

pin
string or null = 5 characters ^\d{5}$

A connector's pin code.

software_version
string

A connector's software version.

type
string

The type of connector.

Enum Value Description
physical

A physical connector.

virtual

A virtual connector.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "hardware_version": "11",
  • "name": "1005123",
  • "pin": "01234",
  • "software_version": "8756",
  • "type": "virtual"
}

Retrieve connectors

Retrieve a list of connectors.

SecurityOAuth2
Request
query Parameters
assigned
boolean

If true, only returns connectors that are assigned to a customer. If false, only those that are not assigned are returned.

customer_id
string <uuid>

Filter connectors by a customer identifier.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

name
string

Filter connectors by name (its human-readable identifier).

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

type
Array of strings non-empty unique

Filter connectors by one or more type.

Items Enum Value Description
physical

A physical connector.

virtual

A virtual connector.

Example: type=virtual
Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Connector) >= 0 items

List of connectors.

Array (>= 0 items)
id
string <uuid>

Connector identifier.

customer_id
string or null <uuid>

Reference to customer to which the connector is assigned.

hardware_version
string

A connector's hardware version.

name
string

Human-readable connector identifier.

pin
string or null = 5 characters ^\d{5}$

A connector's pin code.

software_version
string

A connector's software version.

type
string

The type of connector.

Enum Value Description
physical

A physical connector.

virtual

A virtual connector.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/customers/connectors
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve a single connector

Retrieve a single connector by its identifier.

SecurityOAuth2
Request
path Parameters
connector-id
required
string <uuid>

The identifier of the connector.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Connector identifier.

customer_id
string or null <uuid>

Reference to customer to which the connector is assigned.

hardware_version
string

A connector's hardware version.

name
string

Human-readable connector identifier.

pin
string or null = 5 characters ^\d{5}$

A connector's pin code.

software_version
string

A connector's software version.

type
string

The type of connector.

Enum Value Description
physical

A physical connector.

virtual

A virtual connector.

default

An error occurred - see status code and problem response for more information.

get/v2/customers/connectors/{connector-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "hardware_version": "11",
  • "name": "1005123",
  • "pin": "01234",
  • "software_version": "8756",
  • "type": "virtual"
}

Update a connector

Update connector settings.

SecurityOAuth2
Request
path Parameters
connector-id
required
string <uuid>

The identifier of the connector.

Request Body schema: application/json
required

The connector settings you want to update.

customer_id
string or null <uuid>

Reference to customer to which the connector is assigned.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Connector identifier.

customer_id
string or null <uuid>

Reference to customer to which the connector is assigned.

hardware_version
string

A connector's hardware version.

name
string

Human-readable connector identifier.

pin
string or null = 5 characters ^\d{5}$

A connector's pin code.

software_version
string

A connector's software version.

type
string

The type of connector.

Enum Value Description
physical

A physical connector.

virtual

A virtual connector.

default

An error occurred - see status code and problem response for more information.

put/v2/customers/connectors/{connector-id}
Request samples
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "hardware_version": "11",
  • "name": "1005123",
  • "pin": "01234",
  • "software_version": "8756",
  • "type": "virtual"
}
➔ Next to Contact points