Terminal

The terminal model represents the various attributes and properties of a terminal device. This includes identification details, service line information, and connection statuses, among others. Below, we outline the different properties associated with a terminal.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the device

  • Name
    serial_number
    Type
    string | null
    Description

    The current account number of the service line.

  • Name
    service_line_number
    Type
    string
    Description

    The service line number issued by STARlink

  • Name
    device_id
    Type
    string
    Description

    The device unique identifier issued by vendor

  • Name
    location
    Type
    Location | null
    Description

    The location geometry type, latitude and longitude, see Location

  • Name
    device_type
    Type
    string
    Description

    The device type (Terminal, Access Point, Router, Gateway or Switch)

  • Name
    device_attributes
    Type
    DeviceAttribute | null
    Description

    Device additional attributes, see Device Attributes

  • Name
    uptime
    Type
    int | null
    Description

    The uptime of the device in integer

  • Name
    address
    Type
    Address | null
    Description

    Address associated with the service line.

  • Name
    last_connected_at
    Type
    timestamp | null
    Description

    Start date of the subscription in ISO-8601

  • Name
    last_disconnected_at
    Type
    timestamp | null
    Description

    The service line deactivation date, this can be null

  • Name
    disabled_at
    Type
    timestamp | null
    Description

    The service line deactivation date, this can be null

  • Name
    h3_cell_id
    Type
    int | null
    Description

    Current H3 Cell index of the device

  • Name
    alerts
    Type
    int[] | null
    Description

    The alerts returned by the device

  • Name
    is_online
    Type
    boolean
    Description

    If the device is currently online

Was this page helpful?