Skip to main content
Skip table of contents

Starlink Router Config

Reference: Starlink Portal UI for Router Configuration

⚠️ Note: These router configurations are allowed and managed only via the official Starlink Portal.
The images shown below are provided for reference purposes only.

image-20250901-105745.png
image-20250901-105840.png

✅ Starlink Router Config Update allowed via provided API – Parameters

All the router config present on Starlink Portal can be configured

⚠️ Note: Starlink documentation does not provide official definitions or detailed descriptions

Router config Have 2 section:

  1. Network Configuration

  2. General Settings

⚙️ Network Configuration Parameter Mapping

🔧 1.1 WiFi Networks Configuration (basicServiceSets)

image-20250908-110123.png

Field Label (UI)

Config Parameter

Type

Notes/Conditions

Empty Networks

basicServiceSets: [{}]

object

Network Name

ssid

string

SSID of the network

Password

authWpa2: { password }

string

Network password

WiFi Security

authWpa2, authOpen, etc.

object

Security type of this network

Split 2.4/5 GHz Bands

N/A

N/A

Enable to broadcast 2.4 GHz and 5GHz networks with different SSIDs

Ethernet Only

networks: [{}]

NA

Ethernet only networks will not be available via WiFi and are for routing only

🔐 WiFi Security Type Mapping

UI Option

Config Key

Requires Password

Notes

WPA2

authWpa2

✅

{ password: "..." }

WPA3

authWpa3

✅

{ password: "..." }

WPA2/WPA3

authWpa2Wpa3

✅

{ password: "..." }

WPA3-OWE

authOpenEncrypted

❌

No password object

RADIUS

authRadius

✅/❓

External config needed

OPEN

authOpen

❌

No password object

🌐 1.2 Networking Options

image-20250908-110230.png

Field Label (UI)

Config Parameter

Type

Notes/Conditions

Subnet

ipv4

string

IPv4 Address and subnet

VLAN

vlan

integer

Override the default VLANs used by Starlink mesh. Setting this VLAN may break Starlink mesh functionality.

Guest

guest

boolean

When enabled, clients will not be able to use the Starlink app locally. The router will add a firewall rule for this network that will block local Starlink device APIs

Hidden SSID

hidden

boolean

Hidden networks do not broadcast their SSID and must be joined manually

Client Isolation

clientIsolation

boolean

Block client-to-client (intra-network) traffic. The router will add a layer 3 and layer 2 firewall rule to drop traffic with the same source and destination network.

Disable Network When Offline

disableWhenOffline

boolean

Disable this WiFi network if the router is offline for more than 5 minutes, and automatically re-enable when the router is back online.

Landing Page

landing

string

Landing page (aka captive portal) for this network

📝 Note: If not selected or using default value, do not send these parameters.

📦 1.3 DHCP Configuration

image-20250908-110418.png

Field Label (UI)

Config Parameter

Type

Notes/Conditions

DHCP Disabled

dhcpDisabled

boolean

Disable DHCP for this network

DHCP Start

dhcpv4Start

integer

Lowest DHCP lease index that will be assigned

DHCP End

dhcpv4End

integer

Highest DHCP lease index that will be assigned

1.4 Sandboxing Configuration

image-20250908-111637.png

Field Label (UI)

Config Parameter

Type

Notes/Conditions

Client Sandboxing

sandboxEnabled

boolean

Enable client sandboxing on this network. Sandboxed clients can only access Sandbox Allowed Domains until unsandboxed via remote APIs

Sandbox ID

sandboxId

integer

Sandboxes with the same ID share sandbox state

Sandbox Allowed Domains

sandboxDomainAllowList

array of strings

Public domains accessible while sandboxed, wildcard prefixes allowed
Example: ["example.com", "abc.com"]

🌐 1.5 DNS Configuration: (InProgress)

image-20250908-111712.png

Field Label (UI)

Config Parameter

Type

Notes

TBD

TBD

TBD

Not specified

🧭 1.6 Routing Configuration:(In Progress)

image-20250908-111744.png

Field Label (UI)

Config Parameter

Type

Notes

TBD

TBD

TBD

Not specified

🔧 Example JSON Payload for Network Configuration:

{
"networks": [ { "basicServiceSets": [ { "authWpa2": { },

"band": "RF_2GHZ", "hidden":true, }, { "authWpa2": { }, "band": "RF_5GHZ", "hidden": true } ], "clientIsolation": true, "dhcpDisabled": true, "dhcpv4End": 120, "dhcpv4Start": 10, "disableWhenOffline": true, "guest": true, "ipv4": "10.10.1.255/25", "landing": "https.google.com", "vlan": 1 } ]

}

⚙️ General Settings Parameter Mapping: (In Progress)

Field Label (UI)

Config Parameter(s)

Type

Notes/Conditions

Country Code (l)

applyCountryCode
countryCode
pinCountryCode

boolean
string
boolean

Use applyCountryCode: true to apply.
countryCode must be valid (e.g. "US").

Disable Pending Install Reboot

disablePendingUpdateReboot

boolean

Bypass Mode

bypassMode

boolean

Geo Fencing (l)

Not specified

TBD

TBD

Outdoor Mode

outdoorMode

boolean

DFS Enabled

dfsEnabled

boolean

Disable 2.4 GHz Radio

disable2ghz

boolean

Disable 5 GHz Radio

disable5ghz

boolean

Disable 5 GHz High Radio

disable5ghzHigh

boolean

Channel 2.4 GHz (l)

channel2ghz

integer

Manual channel selection

Channel 5 GHz (l)

channel5ghz

integer

Manual channel selection

HT Bandwidth 2.4 GHz (l)

htBandwidth2ghz

string

e.g., "20MHz" or similar

HT Bandwidth 5 GHz (l)

htBandwidth5ghz

string

VHT Bandwidth (l)

vhtBandwidth

string

Applies to 5GHz high-band

Functionality Requirements: Support for Router Configuration via Kognitive Starlink Services Portal

Case 1: Router already has a configuration assigned

  • Option 1: Update the existing config

    • Consideration: Changes will apply to all routers associated with the same configId.

  • Option 2: Create a new configId based on the existing config (with updates) and assign it to the router

    • Consideration: Over time, this approach will lead to a large number of configurations being created.

Case 2: Router has no configuration

  • Create a new config and assign it to the router

UI Requirements

  1. When the admin clicks on "Update Router Config":

    • Fetch the latest router config

    • Allow the user to update the config as per their requirement

    • Let the user choose:

      • **Update the same config

      • Create a new config (and assign it to the router)

    • User confirms the action

Internal APIs to Apply Router Configuration
(For Development Team Use Only)

1. 📡 Get Router Configuration

Endpoint

CODE 
GET /get_router_configs

Query Parameters

Parameter

Type

Required

Description

organizationId

String

✅ Yes

Unique ID of the organization

accountNumber

String

✅ Yes

Account number associated with the router/device

configId

String

✅ Yes

configId of config associated to router

Example Request

CODE 
GET /get_router_configs?organizationId=DP-1126&accountNumber=ACC-7155004-11306-98&configId=DVC_CFG-DF-112024-61058-55

Response

✅ Success Response

CODE 
{
  "success": true,
  "configJson": "{ \"networks\": [ { \"basicServiceSets\": [ { \"ssid\": \"strlink\", \"band\": \"RF_2GHZ\", \"authWpa2\": { \"password\": \"1234qwad\" } } ] } ] }"
}

ℹ️ Note: configJson is returned as a stringified JSON. You may need to parse it into a JSON object in your application.

2.🔧 Update Router Configuration

Updates the router configuration . Can apply the new configuration or update same router config file.

Endpoint

CODE 
PUT /v2/update_router_config

Request Body

Field

Type

Required

Description

organizationId

String

✅ Yes

Unique identifier for the organization

accountNumber

String

✅ Yes

Account number associated with the router

routerId

String

✅ Yes

Unique router identifier

configId

String

✅ Yes

Identifier for the configuration file being applied

applyNewConfig

Boolean

✅ Yes

Whether to apply the new configuration or update existing config

configJson

JSON

✅ Yes

The actual router configuration in JSON format

Status: In progress

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close