Endpoints

This article describes how to work with data transmission endpoints: from creating and configuring connections to attaching objects and automating the relay process.

Here you will learn:

• What an endpoint is

• How to work with the endpoints list

• How to create endpoints

• How to connect objects to an endpoint

• How to configure automatic connection of new objects

What is an endpoint

An endpoint is a data transmission destination to an external system. It defines connection parameters such as server address, port, data transfer protocol, and authentication settings.

After an endpoint is created, one or more objects can be connected to it.

Endpoints list

To open the endpoints list, go to Relaying → Endpoints.

This tab displays all available data transmission destinations and their current status.

Here you can:

— create new endpoints

— edit existing endpoint settings

— connect objects

— configure automatic object assignment

— view transmission statistics

— enable, disable, or delete endpoints

Top panel

The following actions are available in the top panel:

1. Add — create a new endpoint

2. Statistics — select a period for statistics display

3. Search — search for endpoints in the table

4. Clear filters — reset all filters

Statistics period selection

The Statistics parameter affects the mini-graphs displayed in the table columns:

• Err — errors

• Send — data transmission attempts

• Ack — confirmed packets

These mini-graphs help you quickly evaluate relay performance over a selected period.

The graphs show:

— indicator dynamics

— total number of events for the selected period

When hovering over a point, detailed information is displayed.

Available periods:

• 12 hours — last 12 hours

• Day — last 24 hours

• Week — last week

• 2 weeks — last two weeks

• Month — last month

Endpoints table columns

Actions — available endpoint actions

ID — unique endpoint identifier

Partner ID — owner partner identifier

Partner name — name of the owner partner

Host — external server IP address or domain name

Port — connection port

Format — transmission protocol

Statistics / Objects — number of objects connected to the endpoint

Statistics / Active — number of active objects currently transmitting data

Statistics / Auto — number of contracts with auto-add enabled

Statistics / Queue — number of packets in the sending queue

Statistics / Err — error mini-graph for the selected period

Statistics / Send — send attempt mini-graph for the selected period

Statistics / Ack — received packet mini-graph for the selected period

On/Off — endpoint status (enabled or disabled)

Status — endpoint state: active, disabled, or no active objects

Uspw — authentication data (hidden by default)

Testing — test endpoint flag (admin-only)

TimeZone — time zone

Comment — additional information

Speed Limit — maximum speed transmitted to the external system

Schedule — relay operating schedule

Mapping fields — field mapping settings for specific formats

You can configure which columns are displayed in the table:

1. Click the arrow

in any column header

2. Select Columns

3. Check the columns you want to display

4. Uncheck the ones you want to hide

The same menu also includes:

— sorting ascending

— sorting descending

— filtering data

Endpoint actions

In the Actions column, the following options are available:

Enable/Disable — turn endpoint on or off

Edit — open endpoint settings (you can also double-click the row)

Auto add — configure automatic object assignment

Statistics — open endpoint statistics

Objects — open connected objects list

Delete — remove endpoint

How to create an endpoint

1. Click Add in the top panel

2. Fill in connection parameters:

— Name — endpoint name

— Host — external server address

— Port — external system port

— Format — transmission protocol

— Path — additional URL path if required

— Uspw — authentication data

— Time zone — default time zone for objects

— Speed limit — maximum speed sent to external system

— Enabled — enable/disable endpoint

— Testing — test endpoint mode (admin only)

— JSON config — additional settings in JSON format

— Comment — optional description

— Mapping fields — field mapping for special formats

— Schedule — allowed transmission schedule

3. Click Save

After saving, the endpoint becomes available for object assignment.

How to edit an endpoint

1. Click Edit

in the Actions column or double-click the endpoint row
Endpoints

2. Modify required parameters

3. Click Save

Changes are automatically applied to all objects using this endpoint.

If the system detects a duplicate endpoint configuration, it may suggest merging them. If you do not confirm the merge, changes will not be saved.

Enable or disable an endpoint

To temporarily stop or resume data transmission:

Click the enable

/disable

button in the Actions column

If an endpoint is disabled, all connected objects stop transmitting data to the external system.

How to delete an endpoint

1. Click the Delete

button in the Actions column

2. Confirm deletion

The system will show how many objects are using this endpoint.

After deletion, data transmission through this endpoint stops completely.

Endpoint objects

To view objects connected to an endpoint:

1. Find the required endpoint

2. Click Objects

in the Actions column

This opens a list of all objects sending data through the endpoint.

From here you can:

— add new objects

— edit object relay settings

— temporarily disable transmission

— remove objects from the endpoint

Object list columns

Agent ID — object identifier

Vehicle — object name

IMEI — device identifier

Contract — object contract

External ID — identifier in external system

On/Off — relay status

Err — error mini-graph

Send — send attempt mini-graph

Ack — received packet mini-graph

Object actions:

— enable

/disable

object in endpoint

— remove object

from endpoint

How to add objects

1. Click Add in the Objects window

2. Select one or more objects

3. Optionally edit the External ID (by default IMEI is used)

4. Click Add

If the object list is large, use the Search field at the top.

How to edit an object

1. Double-click the object in the list

2. Edit parameters in the form

Editable parameters:

— Endpoint

— External ID

— Enabled switch

— Speed limit

— Time zone

— Uspw

— JSON config

— Schedule

The following parameters cannot be changed here:

Host, Port, Format, Path (they are inherited from the endpoint)

3. Click Save

Automatic object assignment (Auto add)

The Auto add feature automatically connects new objects to an endpoint.

It is useful when all objects of a contract must send data to the same external system.

After configuration, new objects are automatically assigned without manual setup.

How to configure Auto add

1. Click Auto add

in the Actions column

2. In the window, click Add in the list of contracts

3. Select one or more contracts

4. Click Add again to confirm

After saving, all new objects from selected contracts will automatically be connected to this endpoint