STstarlink
User Terminals

Set L2VPN VLANs for user terminal

Required permission: Device configuration assignment, Edit.<br/>Terminal must be on subscription that allows L2VPN. Maximum 2 circuits per Starlink PoP. Use null or empty circuit list to clear all L2VPN circuits for terminal. See /user-terminals/available-circuits for all configurable circuits and associated Starlink PoP.

put/public/v2/user-terminals/{deviceId}/l2vpn

Request

  • Base URL
    https://starlink.com/api
  • URL
    https://starlink.com/api/public/v2/user-terminals/{deviceId}/l2vpn
  • Auth
    HTTP bearer

Path parameters

deviceIdstring required

User terminal ID, kit serial number, or dish serial number.

Request body

circuitIdstring nullable

Deprecated field: use CircuitIds instead. Mutually exclusive with CircuitIds. Starlink generated Id of L2VPN circuit.

circuitIdsstring[] required

Starlink generated Ids of L2VPN circuit(s) in this circuit group. If multiple circuitIds are present then they are functioning as a redundant group and must be located at the same PoP. Mutually exclusive with deprecated CircuitId field.

customerVlansinteger[] required

Customer VLANs are the inner tag and identify L2VPN customer traffic to and from a user terminal.

serviceVlaninteger nullable

Outer VLAN tag used for Q-in-Q and identifies a single ethernet virtual circuit (EVC) for a user terminal. Null or 0 if no service VLAN tag should be added.

customerVlanRemapinteger nullable

Traffic tagged with the specified customer VLAN will have that VLAN tag remapped en-route to the value of customerVlanRemap if present. If remapping is occurring then CustomerVlans must contain a single value. Set value to null or 0 for no remapping.

Response

Successfully assigned circuits

informationstring[] nullable
isValidboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.