Networking

Retrieve a Router

Work with Routers.Retrieves the Router with the given ID.

get/admin/networking/routers/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/networking/routers/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Router.

Response

titlestring required

Title (unique)

modelstring

Model

partners_idsstring[] required

Partners (ids)

location_idnumber required

Location (id)

addressstring

Address

ipstring required

Router IP (unique)

gpsstring

Area router

gps_pointstring

Point router

authorization_method'none' | 'firewall_ip_mac_filter' | 'dhcp_leases' | 'ppp_dhcp_radius' | 'ppp_secrets' | 'hotspot_users' | 'hotspot_radius' required

Authorization method

accounting_method'none' | 'radius' | 'netflow' required

Accounting method

nas_typestring required

ID of NAS type. You can get it on page "Config / Networking / NAS types"

nas_ipstring

IP address assigned to the NAS

radius_secretstring

Radius secret

status'null' | 'ok' | 'api_error' | 'error' | 'disabled' | 'unknown'

Router status

pool_idsstring[]

Pool IDs

idnumber

Router ID

Example response

{
  "title": "Alpha",
  "model": "Mega router",
  "partners_ids": [
    "1"
  ],
  "location_id": 1,
  "address": "Big street 11-321",
  "ip": "192.168.1.100",
  "gps": "45.83,126.62;45.85,126.63;45.85,126.60;45.84,126.60;45.83950371555224,126.62528514862058;",
  "gps_point": "45.83,126.62",
  "authorization_method": "none",
  "accounting_method": "none",
  "nas_type": "1",
  "nas_ip": "192.168.1.100",
  "radius_secret": "",
  "status": "null",
  "pool_ids": [
    "1"
  ],
  "id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.