High Level API specification Vodafone Proposal

From PRPL
Jump to: navigation, search

DISCLAIMER The specification below is the draft specification as shared by VF. Therefore, the objects, data-models and object paths on this page do not constitute the final API as adopted by Prpl but are merely one of the proposed approaches.

Background[edit]

The high-level API is designed to give services running on top of any internet access device (IAD) or router access to a standardized set of methods to interact with the underlying platform.

The VF proposal is base on reusing the uBus specification.

In a nutshell, every API and low level interaction is implemented by the respective HW manufacturer and exposed as a an object on uBus. Similar to RDK-B's architecture, the higher level service, such as the web UI, can interact with the system via abstracted uBus calls rather than integrating with specific systems.

In line with that logic, the specification below is sorted by objects.

Contents

API[edit]

Interfaces.IP[edit]

Method Args Response Description
Add {
"Id": "WAN_Mobile",
"Name": "Mobile",
"Enabled": true,
"IPv4": {
"Protocol": "DHCP",
"Address": "82.14.2.1",
"NetworkMask": "255.255.255.0",
"Broadcast": "82.14.2.255"
},
"IPv6": {
"Protocol": "DHCP",
"LinkLocalAddress": "fe80::a00:27ff:fe70:e3f5",
"GlobalAddress": "2001::a00:27ff:fe70:e3f5",
"Prefix": 64
},
"PhysicalInterface": "Interfaces.Physical.WAN.xDSL.PVCs.035"

}

{
"Id": "WAN_Mobile"

}

Adds a new IP Interface.
List {
"Limit": 10,
"Offset": 0

}

{
"InterfacesList": [
{
"Id": "WAN_Mobile",
"Name": "Mobile",
"Enabled": true,
"Status": "Active",
"IPv4": {
"Protocol": "DHCP",
"Address": "82.14.2.1",
"NetworkMask": "255.255.255.0",
"Broadcast": "82.14.2.255"
},
"IPv6": {
"Protocol": "DHCP",
"LinkLocalAddress": "fe80::a00:27ff:fe70:e3f5",
"GlobalAddress": "2001::a00:27ff:fe70:e3f5",
"Prefix": 64
},
"PhysicalInterface": "Interfaces.Physical.WAN.xDSL.PVCs.035",
"Statistics": {
"Packets": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Dropped": {
"Transmitted": 0,
"Received": 0
},
"Errors": {
"Transmitted": 0,
"Received": 0
},
"Collisions": 0
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of IP Interfaces.


Interfaces.IP.{InterfaceId}[edit]

Method Args Response Description
Delete - - Deletes the specified IP Interface.
Get - {
"Id": "WAN_Mobile",
"Name": "Mobile",
"Enabled": true,
"Status": "Active",
"IPv4": {
"Protocol": "DHCP",
"Address": "82.14.2.1",
"NetworkMask": "255.255.255.0",
"Broadcast": "82.14.2.255"
},
"IPv6": {
"Protocol": "DHCP",
"LinkLocalAddress": "fe80::a00:27ff:fe70:e3f5",
"GlobalAddress": "2001::a00:27ff:fe70:e3f5",
"Prefix": 64
},
"PhysicalInterface": "Interfaces.Physical.WAN.xDSL.PVCs.035",
"Statistics": {
"Packets": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Dropped": {
"Transmitted": 0,
"Received": 0
},
"Errors": {
"Transmitted": 0,
"Received": 0
},
"Collisions": 0
}

}

Retrieves the status and configuration parameters in regards to the (specified) IP Interface.
ResetStatistics - - Resets the statistics counters of the (specified) IP Interface.
Set {
"Name": "Mobile",
"Enabled": true,
"IPv4": {
"Protocol": "DHCP",
"Address": "82.14.2.1",
"NetworkMask": "255.255.255.0",
"Broadcast": "82.14.2.255"
},
"IPv6": {
"Protocol": "DHCP",
"LinkLocalAddress": "fe80::a00:27ff:fe70:e3f5",
"GlobalAddress": "2001::a00:27ff:fe70:e3f5",
"Prefix": 64
},
"PhysicalInterface": "Interfaces.Physical.WAN.xDSL.PVCs.035",

}

- Modifies the status and configuration parameters of the (specified) IP Interface.


Interfaces.Physical.Network.LAN.EthernetSwitch.Ports[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "0",
"Name": "Eth0",
"Enabled": true,
"Mode": [
"FastEthernet",
"GigabitEthernet"
],
"EnergyEfficientEthernet": true,
"AutoNegotiation": true,
"Duplex": [
"Half",
"Full"
],
"Status": {
"State": "Active",
"Protocol": "GigabitEthernet",
"Duplex": "Full",
"Uptime": 3600
},
"Statistics": {
"Frames": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Ethernet Switch Ports.


Interfaces.Physical.Network.LAN.EthernetSwitch.Ports.{PortId}[edit]

Method Args Response Description
Get - {
"Id": "0",
"Name": "Eth0",
"Enabled": true,
"Mode": [
"FastEthernet",
"GigabitEthernet"
],
"EnergyEfficientEthernet": true,
"AutoNegotiation": true,
"Duplex": [
"Half",
"Full"
],
"Status": {
"State": "Active",
"Protocol": "GigabitEthernet",
"Duplex": "Full",
"Uptime": 3600
},
"Statistics": {
"Frames": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) Ethernet Switch Port.
ResetStatistics - - Resets the statistics counters of the (specified) Ethernet Switch Port.
Set {
"Name": "Eth0",
"Enabled": true,
"Mode": [
"FastEthernet",
"GigabitEthernet"
],
"EnergyEfficientEthernet": true,
"AutoNegotiation": true,
"Duplex": [
"Half",
"Full"
]

}

- Modifies the status and configuration parameters of the (specified) Ethernet Switch Port.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "5ghz",
"Name": "5 GHz",
"Enabled": true,
"Capabilities": "3x3",
"Country": "DE",
"Band": 5,
"Bandwidth": {
"20": true,
"40": true
},
"Channels": {
"Preferred": 36,
"List": {
"34": true,
"36": true,
"38": true,
"40": true
},
"Selection": {
"Mode": "Automatic",
"Timer": 3600
}
},
"Standard": {
"802.11n": true,
"802.11ac": true
},
"Status": {
"State": "Active",
"Channel": 36,
"Bandwidth": 20,
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Packets": {
"Transmitted": 0,
"Received": 0
},
"StationsCount": 0
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Wi-Fi Radios.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}[edit]

Method Args Response Description
Get - {
"Id": "5ghz",
"Name": "5 GHz",
"Enabled": true,
"Capabilities": "3x3",
"Country": "DE",
"Band": 5,
"Bandwidth": {
"20": true,
"40": true
},
"Channels": {
"Preferred": 36,
"List": {
"34": true,
"36": true,
"38": true,
"40": true
},
"Selection": {
"Mode": "Automatic",
"Timer": 3600
}
},
"Standard": {
"802.11n": true,
"802.11ac": true
},
"Status": {
"State": "Active",
"Channel": 36,
"Bandwidth": 20,
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Packets": {
"Transmitted": 0,
"Received": 0
},
"StationsCount": 0
}

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi Radio.
ResetStatistics - - Resets the statistics counters of the (specified) Wi-Fi Radio.
Set {
"Name": "5 GHz",
"Enabled": true,
"Country": "DE",
"Band": 5,
"Bandwidth": {
"20": true,
"40": true
},
"Channels": {
"Preferred": 36,
"List": {
"34": true,
"36": true,
"38": true,
"40": true
},
"Selection": {
"Mode": "Automatic",
"Timer": 3600
}
},
"Standard": {
"802.11n": true,
"802.11ac": true
}

}

- Modifies the status and configuration parameters of the (specified) Wi-Fi Radio.
TriggerAutomaticChannelSelection - - Triggers an automatic channel selection on the (specified) Wi-Fi Radio.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}.BSSs[edit]

Method Args Response Description
Add {
"Id": "Guest",
"Name": "Guest",
"Enabled": true,
"Broadcast": true,
"BSSID": "AA:BB:CC:00:11:22",
"SSID": "My Guest Network",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"Encryption": "AES"

}

{
"Id": "Guest"

}

Adds a new Wi-Fi BSS.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "Guest",
"Name": "Guest",
"Enabled": true,
"Status": "Active",
"Broadcast": true,
"BSSID": "AA:BB:CC:00:11:22",
"SSID": "My Guest Network",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"Encryption": "AES",
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Packets": {
"Transmitted": 0,
"Received": 0
},
"StationsCount": 0
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Wi-Fi BSSs.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}.BSSs.{BSSId}[edit]

Method Args Response Description
Delete - - Deletes the specified Wi-Fi BSS.
Get - {
"Id": "Guest",
"Name": "Guest",
"Enabled": true,
"Status": "Active",
"Broadcast": true,
"BSSID": "AA:BB:CC:00:11:22",
"SSID": "My Guest Network",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"Encryption": "AES",
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Packets": {
"Transmitted": 0,
"Received": 0
},
"StationsCount": 0
}

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi BSS.
ResetStatistics - - Resets the statistics counters of the (specified) Wi-Fi BSS.
Set {
"Id": "Guest",
"Name": "Guest",
"Enabled": true,
"Broadcast": true,
"BSSID": "AA:BB:CC:00:11:22",
"SSID": "My Guest Network",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"Encryption": "AES"

}

- Modifies the status and configuration parameters of the (specified) Wi-Fi BSS.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}.BSSs.{BSSId}.Stations[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 1,
"MAC": "AA:BB:CC:00:11:22",
"Status": {
"State": "Connected",
"Idle": "53",
"MCS": 15,
"PhysicalRate": 300,
"ReceivedSignalStrength": -40,
"Bandwidth": 20,
"GuardInterval": 400,
"SpatialStreams": 2,
"Standard": "802.11n"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Packets": {
"Transmitted": 0,
"Received": 0
}
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Wi-Fi Stations.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}.BSSs.{BSSId}.Stations.{StationId}[edit]

Method Args Response Description
Get - {
"Id": 1,
"MAC": "AA:BB:CC:00:11:22",
"Status": {
"State": "Connected",
"Idle": "53",
"MCS": 15,
"PhysicalRate": 300,
"ReceivedSignalStrength": -40,
"Bandwidth": 20,
"GuardInterval": 400,
"SpatialStreams": 2,
"Standard": "802.11n"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Packets": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi Station.
ResetStatistics - - Resets the statistics counters of the (specified) Wi-Fi Station.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}.ESSs[edit]

Method Args Response Description
Add {
"Id": "Private",
"Name": "Private",
"Enabled": true,
"SSID": "prplFoundation",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"Encryption": "AES",
"BSSs": [
"Interfaces.Physical.Wi-Fi.Radios.24ghz.BSSs.Private",
"Interfaces.Physical.Wi-Fi.Radio.5ghz.BSSs.Private"
]

}

{
"Id": "Private"

}

Adds a new Wi-Fi ESS.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "Private",
"Name": "Private",
"Enabled": true,
"Status": "Active",
"SSID": "prplFoundation",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"BSSs": [
"Interfaces.Physical.Wi-Fi.Radios.24ghz.BSSs.Private",
"Interfaces.Physical.Wi-Fi.Radio.5ghz.BSSs.Private"
]
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Wi-Fi ESSs.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}.ESSs.{ESSId}[edit]

Method Args Response Description
Delete - - Deletes the specified Wi-Fi ESS.
Get - {
"Id": "Private",
"Name": "Private",
"Enabled": true,
"Status": "Active",
"SSID": "prplFoundation",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"Encryption": "AES",
"BSSs": [
"Interfaces.Physical.Wi-Fi.Radios.24ghz.BSSs.Private",
"Interfaces.Physical.Wi-Fi.Radio.5ghz.BSSs.Private"
]

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi ESS.
Set {
"Name": "Private",
"Enabled": true,
"SSID": "prplFoundation",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"Encryption": "AES",
"BSSs": [
"Interfaces.Physical.Wi-Fi.Radios.24ghz.BSSs.Private",
"Interfaces.Physical.Wi-Fi.Radio.5ghz.BSSs.Private"
]

}

- Modifies the status and configuration parameters of the (specified) Wi-Fi ESS.


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}.SiteSurveys[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "Private",
"Name": "Private",
"Enabled": true,
"Status": "Active",
"SSID": "prplFoundation",
"SecurityKey": "abc12345678",
"SecurityMode": "WPA2",
"Encryption": "AES",
"BSSs": [
"Interfaces.Physical.Wi-Fi.Radios.24ghz.BSSs.Private",
"Interfaces.Physical.Wi-Fi.Radio.5ghz.BSSs.Private"
]
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Wi-Fi Radio Sitey Survey (Spectrum Scan)s.
Queue - {
"Id": 1

}

Queues a new Wi-Fi Radio Sitey Survey (Spectrum Scan).


Interfaces.Physical.Network.LAN.Wi-Fi.Radios.{RadioId}.SiteSurveys.{SiteSurvey}[edit]

Method Args Response Description
Delete - - Deletes the specified Wi-Fi Radio Sitey Survey (Spectrum Scan).
Get - {
"Id": 1,
"Status": "Complete",
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Channels": [
{
"Id": 1,
"Grade": 93,
"BSSCount": 5,
"Noise": {
"Average": -80,
"Background": -100
},
"SignalNoiseRatio ": 20,
"Usage": 0.23
}
]
}

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi Radio Sitey Survey (Spectrum Scan).


Interfaces.Physical.Network.WAN[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "DOCSIS",
"Name": "DOCSIS",
"Enabled": true,
"Mode": [
"DOCSIS 3.1",
"DOCSIS 3.0"
],
"Status": {
"State": "Active",
"Protocol": "DOCSIS 3.1",
"SyncSpeed": {
"Downstream": 80000000,
"Upstream": 40000000
},
"SignalNoiseRatio": 20,
"Uptime": 3600
},
"Statistics": {
"Frames": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of WAN Interfaces.


Interfaces.Physical.Network.WAN.DOCSIS[edit]

Method Args Response Description
Get - {
"Id": "DOCSIS",
"Name": "DOCSIS",
"Enabled": true,
"Mode": [
"DOCSIS 3.1",
"DOCSIS 3.0"
],
"Status": {
"State": "Active",
"Protocol": "DOCSIS 3.1",
"SyncSpeed": {
"Downstream": 80000000,
"Upstream": 40000000
},
"SignalNoiseRatio": 20,
"Uptime": 3600
},
"Statistics": {
"Frames": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) DOCSIS WAN Interface.
ResetStatistics - - Resets the statistics counters of the (specified) DOCSIS WAN Interface.
Set {
"Name": "DOCSIS",
"Enabled": true,
"Mode": [
"DOCSIS 3.1",
"DOCSIS 3.0"
]

}

- Modifies the status and configuration parameters of the (specified) DOCSIS WAN Interface.


Interfaces.Physical.Network.WAN.Ethernet[edit]

Method Args Response Description
Get - {
"Id": "Ethernet",
"Name": "Ethernet",
"Enabled": true,
"Mode": [
"FastEthernet",
"GigabitEthernet"
],
"EnergyEfficientEthernet": true,
"AutoNegotiation": true,
"Duplex": [
"Half",
"Full"
],
"Status": {
"State": "Active",
"Protocol": "GigabitEthernet",
"Duplex": "Full",
"Uptime": 3600
},
"Statistics": {
"Frames": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) Ethernet WAN Interface.
ResetStatistics - - Resets the statistics counters of the (specified) Ethernet WAN Interface.
Set {
"Name": "Ethernet",
"Enabled": true,
"Mode": [
"FastEthernet",
"GigabitEthernet"
],
"EnergyEfficientEthernet": true,
"AutoNegotiation": true,
"Duplex": [
"Half",
"Full"
]

}

- Modifies the status and configuration parameters of the (specified) Ethernet WAN Interface.


Interfaces.Physical.Network.WAN.Fibre[edit]

Method Args Response Description
Get - {
"Id": "Fibre",
"Name": "Fibre",
"Enabled": true,
"Mode": [
"GPON"
],
"Status": {
"State": "Active",
"Protocol": "GPON",
"Uptime": 3600
},
"Statistics": {
"Frames": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) Fibre WAN Interface.
ResetStatistics - - Resets the statistics counters of the (specified) Fibre WAN Interface.
Set {
"Id": "Fibre",
"Name": "Fibre",
"Enabled": true,
"Mode": [
"GPON"
]

}

- Modifies the status and configuration parameters of the (specified) Fibre WAN Interface.


Interfaces.Physical.Network.WAN.Mobile[edit]

Method Args Response Description
Get - {
"Id": "Mobile",
"Name": "Mobile",
"Enabled": true,
"Mode": {
"4G": [
"LTE Advanced",
"LTE"
],
"3G": [
"HSPA+",
"UMTS"
]
},
"Status": {
"State": "Active",
"Generation": "4G",
"Protocol": "LTE",
"Grade": 0.70,
"SignalNoiseRatio": 25,
"ReferenceSignalReceivedQuality": -10,
"ReferenceSignalReceivedPower": -80,
"ReceivedSignalStrengthIndicator": 0,
"Uptime": 3600
},
"Statistics": {
"Frames": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) Mobile WAN Interface.
ResetStatistics - - Resets the statistics counters of the (specified) Mobile WAN Interface.
Set {
"Name": "Mobile",
"Enabled": true,
"Mode": {
"4G": [
"LTE Advanced",
"LTE"
],
"3G": [
"HSPA+",
"UMTS"
]
}

}

- Modifies the status and configuration parameters of the (specified) Mobile WAN Interface.


Interfaces.Physical.Network.WAN.Mobile.SIM[edit]

Method Args Response Description
Get - {
"PIN": 1234,
"PUK": 9876,
"Status": "Locked",
"Statistics": {
"FailedUnlockAttemptsCount": 2
}

}

Retrieves the status and configuration parameters in regards to the (specified) Mobile SIM Card.
Set {
"PIN": 1234

}

- Modifies the status and configuration parameters of the (specified) Mobile SIM Card.
Unlock {
"PIN": 1234

}

- Attempts to unlock the specified Mobile SIM Card.


Interfaces.Physical.Network.WAN.xDSL[edit]

Method Args Response Description
Get - {
"Id": "xDSL",
"Name": "xDSL",
"Enabled": true,
"Mode": [
"ADSL2+",
"VDSL2"
],
"Status": {
"State": "Active",
"Protocol": "ADSL2+",
"SyncSpeed": {
"Downstream": 24000000,
"Upstream": 1000000
},
"SignalNoiseRatio": 20,
"Uptime": 3600
},
"Statistics": {
"Frames": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) xDSL WAN Interface.
ResetStatistics - - Resets the statistics counters of the (specified) xDSL WAN Interface.
Set {
"Name": "xDSL",
"Enabled": true,
"Mode": [
"ADSL2+",
"VDSL2"
]

}

- Modifies the status and configuration parameters of the (specified) xDSL WAN Interface.


Interfaces.Physical.Voice.DECT[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Protocol": "CAT-iq 4.0",
"Statistics": {
"ConnectedDevicesCount": 3
}

}

Retrieves the status and configuration parameters in regards to the (specified) DECT Voice Interface.
Set {
"Enabled": true,
"Protocol": "CAT-iq 4.0"

}

- Modifies the status and configuration parameters of the (specified) DECT Voice Interface.


Interfaces.Physical.Voice.FXS[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Name": "FXS1",
"Enabled": true,
"Status": "Active",
"Signaling": "DTMF"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of FXS Voice Interfaces.


Interfaces.Physical.Voice.FXS.{InterfaceId}[edit]

Method Args Response Description
Get - {
"Id": 0,
"Name": "FXS1",
"Enabled": true,
"Status": "Active",
"Signaling": "DTMF"

}

Retrieves the status and configuration parameters in regards to the (specified) FXS Voice Interface.
Set {
"Enabled": true,
"Signaling": "DTMF"

}

- Modifies the status and configuration parameters of the (specified) FXS Voice Interface.


Services.Broadband[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
"Services.Broadband.Data",
"Services.Broadband.Voice",
"Services.Broadband.TV",
"Services.Broadband.CommunityWi-Fi"
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Broadband Services.


Services.Broadband.CommunityWi-Fi[edit]

Method Args Response Description
Get - {
"Id": "FON",
"Name": "Community Wi-Fi",
"Enabled": true,
"Status": "Active",
"IPInterfacesList": [
"Interfaces.IP.WAN_xDSL",
"Interfaces.IP.WAN_Mobile"
],
"NetworkMode": "Fallback"

}

Retrieves the status and configuration parameters in regards to the (specified) Broadband Community Wi-Fi Service.
Set {
"Name": "Community Wi-Fi",
"Enabled": true,
"IPInterfacesList": [
"Interfaces.IP.WAN_xDSL",
"Interfaces.IP.WAN_Mobile"
],
"NetworkMode": "Fallback"

{

"Id": "FON",
"Name": "Community Wi-Fi",
"Enabled": true,
"Status": "Active",
"IPInterfacesList": [
"Interfaces.IP.WAN_xDSL",
"Interfaces.IP.WAN_Mobile"
],
"NetworkMode": "Fallback"

}

- Modifies the status and configuration parameters of the (specified) Broadband Community Wi-Fi Service.


Services.Broadband.Data[edit]

Method Args Response Description
Get - {
"Id": "Data",
"Name": "Internet",
"Enabled": true,
"Status": "Active",
"IPInterfacesList": [
"Interfaces.IP.WAN_xDSL",
"Interfaces.IP.WAN_Mobile"
],
"NetworkMode": "Fallback"

}

Retrieves the status and configuration parameters in regards to the (specified) Broadband Data Service.
Set {
"Id": "Data",
"Name": "Internet",
"Enabled": true,
"IPInterfacesList": [
"Interfaces.IP.WAN_xDSL",
"Interfaces.IP.WAN_Mobile"
],
"NetworkMode": "Fallback"

}

- Modifies the status and configuration parameters of the (specified) Broadband Data Service.


Services.Broadband.TV[edit]

Method Args Response Description
Get - {
"Id": "TV",
"Name": "Video",
"Enabled": true,
"Status": "Active",
"IPInterfacesList": [
"Interfaces.IP.WAN_xDSL"
],
"NetworkMode": "Fallback"

}

Retrieves the status and configuration parameters in regards to the (specified) Broadband TV Service.
Set {
"Name": "Video",
"Enabled": true,
"IPInterfacesList": [
"Interfaces.IP.WAN_xDSL"
],
"NetworkMode": "Fallback"

}

- Modifies the status and configuration parameters of the (specified) Broadband TV Service.


Services.Broadband.TV.IGMP.Proxy[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Protocol": "3.0",
"QueryTimeInterval": 60,
"MaximumStreams": 5,
"InboundInterface": "Interfaces.IP.Br0",
"Status": {
"State": "Active",
"ActiveGroups": [
{
"Id": 0,
"Address": "224.0.0.22",
"Host": "192.168.1.4",
"Expires": 30
}
]
},
"Statistics": {
"IGMPPackets": {
"Queries": {
"Sent": 0,
"Received": 0
},
"Join": {
"Received": 0
},
"Leave": {
"Received": 0
}
}
}

}

Modifies the status and configuration parameters of the (specified) Broadband TV Service.
ResetStatistics - - Retrieves the status and configuration parameters in regards to the (specified) IPTV IGMP Proxy.
Set {
"Enabled": true,
"Protocol": "3.0",
"QueryTimeInterval": 60,
"MaximumStreams": 5,
"InboundInterface": "Interfaces.IP.Br0"

}

- Resets the statistics counters of the (specified) IPTV IGMP Proxy.


Services.Broadband.TV.IGMP.Snooping[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Interfaces": [
"Interfaces.Physical.LAN.EthernetSwitch.Ports.0",
"Interfaces.Physical.LAN.EthernetSwitch.Ports.1",
"Interfaces.Physical.LAN.EthernetSwitch.Ports.2",
"Interfaces.Physical.LAN.EthernetSwitch.Ports.3",
"Interfaces.Physical.LAN.Wi-Fi.Radios.24GHz.BSSs.Private",
"Interfaces.Physical.LAN.Wi-Fi.Radios.5GHz.BSSs.Private"
]

}

Modifies the status and configuration parameters of the (specified) IPTV IGMP Proxy.
Set {
"Enabled": true,
"Interfaces": [
"Interfaces.Physical.LAN.EthernetSwitch.Ports.0",
"Interfaces.Physical.LAN.EthernetSwitch.Ports.1",
"Interfaces.Physical.LAN.EthernetSwitch.Ports.2",
"Interfaces.Physical.LAN.EthernetSwitch.Ports.3",
"Interfaces.Physical.LAN.Wi-Fi.Radios.24GHz.BSSs.Private",
"Interfaces.Physical.LAN.Wi-Fi.Radios.5GHz.BSSs.Private"
]

}

- Retrieves the status and configuration parameters in regards to the (specified) IPTV IGMP Snooping.


Services.Broadband.Voice.SIP.Client[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Registrar": {
"Address": "registrar.ims.prplFoundation.com",
"Port": 5070
},
"InboundProxy": {
"Address": "proxy.ims.prplFoundation.com",
"Port": 5060
},
"OutboundProxy": {
"Address": "proxy.ims.prplFoundation.com",
"Port": 5060
}

}

Retrieves the status and configuration parameters in regards to the (specified) SIP Client.
Set {
"Enabled": true,
"Registrar": {
"Address": "registrar.ims.prplFoundation.com",
"Port": 5070
},
"InboundProxy": {
"Address": "proxy.ims.prplFoundation.com",
"Port": 5060
},
"OutboundProxy": {
"Address": "proxy.ims.prplFoundation.com",
"Port": 5060
}

}

- Modifies the status and configuration parameters of the (specified) SIP Client.


Services.Broadband.Voice.SIP.Client.Codecs[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "g726",
"Name": "G.726",
"Enabled": true,
"Priority": 1,
"Packetization": 20
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of SIP Client Codecs.


Services.Broadband.Voice.SIP.Client.Codecs.{CodecId}[edit]

Method Args Response Description
Get - {
"Id": "g726",
"Name": "G.726",
"Enabled": true,
"Priority": 1,
"Packetization": 20

}

Retrieves the status and configuration parameters in regards to the (specified) SIP Client Codec.
Set {
"Enabled": true,
"Priority": 1,
"Packetization": 20

}

- Modifies the status and configuration parameters of the (specified) SIP Client Codec.


Services.Broadband.Voice.SIP.Client.Extensions[edit]

Method Args Response Description
List - {
"List": [
{
"Id": 0,
"Enabled": true,
"Status": "Registered",
"URI": "0015417543010@prplFoundation.com",
"Realm": "de",
"Username": "0015417543010",
"Password": "prplFoundation"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of SIP Client Codecs.


Services.Broadband.Voice.SIP.Client.Extensions.{ExtensionId}[edit]

Method Args Response Description
Get - {
"Id": 0,
"Enabled": true,
"Status": "Registered",
"URI": "0015417543010@prplFoundation.com",
"Realm": "de",
"Username": "0015417543010",
"Password": "prplFoundation"

}

Retrieves the status and configuration parameters in regards to the (specified) SIP Client Extension.
Set {
"Id": 0,
"Enabled": true,
"URI": "0015417543010@prplFoundation.com",
"Realm": "de",
"Username": "0015417543010",
"Password": "prplFoundation"

}

- Modifies the status and configuration parameters of the (specified) SIP Client Extension.


Services.Diagnostics.NSLookup.Tests[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 32,
"Server": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"Query": {
"Name": "www.prplFoundation.com",
"Type": [
"A",
"AAAA"
]
},
"AnswersList": [
{
"Id": 1,
"Address": "47.73.47.128",
"TimeToLive": 323,
"Type": "A"
},
{
"Id": 2,
"Address": "47.73.47.129",
"TimeToLive": 132,
"Type": "A"
}
],
"Status": "Complete",
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Duration": 30
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of DNS Lookup Tests.
Queue {
"Server": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"Query": {
"Name": "www.prplFoundation.com",
"Type": [
"A",
"AAAA"
]
}
}
{
"Id": 32

}

Queues a new DNS Lookup Test.


Services.Diagnostics.NSLookup.Tests.{TestId}[edit]

Method Args Response Description
Delete - - Deletes the specified DNS Lookup Test.
Get - {
"Id": 32,
"Server": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"Query": {
"Name": "www.prplFoundation.com",
"Type": [
"A",
"AAAA"
]
},
"AnswersList": [
{
"Id": 1,
"Address": "47.73.47.128",
"TimeToLive": 323,
"Type": "A"
},
{
"Id": 2,
"Address": "47.73.47.129",
"TimeToLive": 132,
"Type": "A"
}
],
"Status": "Complete",
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Duration": 30
}

}

Retrieves the status and configuration parameters in regards to the (specified) DNS Lookup Test.


Services.Diagnostics.NetworkSpeed.Tests[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 32,
"Address": "https://speedtest.prplFoundation.com",
"TransportProtocol": "TCP",
"Direction": "Download",
"Streams": 4,
"Interface": "Interfaces.IP.WAN_FTTH",
"Status": "Complete",
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Throughput": {
"Minimum": 100000000,
"Average": 120000000,
"Maximum": 140000000
},
"TransferedData": 3600000000,
"Duration": 30
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Network Speed Tests.
Queue {
"Address": "https://speedtest.prplFoundation.com",
"TransportProtocol": "TCP",
"Direction": "Download",
"Streams": 4,
"Interface": "Interfaces.IP.WAN_FTTH"

}

{
"Id": 32

}

Queues a new Network Speed Test.


Services.Diagnostics.NetworkSpeed.Tests.{TestId}[edit]

Method Args Response Description
Delete - - Deletes the specified Network Speed Test.
Get - {
"Id": 32,
"Address": "https://speedtest.prplFoundation.com",
"TransportProtocol": "TCP",
"Direction": "Download",
"Streams": 4,
"Interface": "Interfaces.IP.WAN_FTTH",
"Status": "Complete",
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Throughput": {
"Minimum": 100000000,
"Average": 120000000,
"Maximum": 140000000
},
"TransferedData": 3600000000,
"Duration": 30
}

}

Retrieves the status and configuration parameters in regards to the (specified) Network Speed Test.


Services.Diagnostics.Ping.Tests[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 32,
"Address": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"Count": 4,
"Size": 1450,
"Fragment": false,
"TimeToLive": 15,
"Status": "Complete",
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Latency": {
"Minimum": 3,
"Average": 5,
"Maximum": 7
},
"Jitter": {
"Minimum": 3,
"Average": 5,
"Maximum": 7
},
"PacketLoss": 0.00,
"Duration": 30
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Ping Tests.
Queue {
"Address": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"Count": 4,
"Size": 1450,
"Fragment": false,
"TimeToLive": 15

}

{
"Id": 32

}

Queues a new Ping Test.


Services.Diagnostics.Ping.Tests.{TestId}[edit]

Method Args Response Description
Delete - - Deletes the specified Ping Test.
Get - {
"Id": 32,
"Address": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"Count": 4,
"Size": 1450,
"Fragment": false,
"TimeToLive": 15,
"Status": "Complete",
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Latency": {
"Minimum": 3,
"Average": 5,
"Maximum": 7
},
"Jitter": {
"Minimum": 3,
"Average": 5,
"Maximum": 7
},
"PacketLoss": 0.00,
"Duration": 30
}

}

Retrieves the status and configuration parameters in regards to the (specified) Ping Test.


Services.Diagnostics.Traceroute.Tests[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 32,
"Status": "Complete",
"Address": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"TimeToLive": 15,
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Hops": [
{
"Id": 1,
"Name": "router",
"Address": "192.168.1.1",
"Latency": {
"Minimum": 3,
"Average": 5,
"Maximum": 7
},
"Jitter": {
"Minimum": 3,
"Average": 5,
"Maximum": 7
},
"PacketLoss": 0.00
}
],
"Duration": 30
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Traceroute Tests.
Queue {
"Address": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"TimeToLive": 15

}

{
"Id": 32

}

Queues a new Traceroute Test.


Services.Diagnostics.Traceroute.Tests.{TestId}[edit]

Method Args Response Description
Delete - - Deletes the specified Traceroute Test.
Get - {
"Id": 32,
"Status": "Complete",
"Address": "8.8.8.8",
"Interface": "Interfaces.IP.WAN_FTTH",
"TimeToLive": 15,
"Timestamp": "2017-09-12 14:32:10",
"Statistics": {
"Hops": [
{
"Id": 1,
"Name": "router",
"Address": "192.168.1.1",
"Latency": {
"Minimum": 3,
"Average": 5,
"Maximum": 7
},
"Jitter": {
"Minimum": 3,
"Average": 5,
"Maximum": 7
},
"PacketLoss": 0.00
}
],
"Duration": 30
}

}

Retrieves the status and configuration parameters in regards to the (specified) Traceroute Test.


Services.Local.Bridge[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Port": "Interfaces.Physical.Network.LAN.EthernetSwitch.Ports.1",
"Statistics": {
"Packets": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) WAN Bridge.
ResetStatistics - - Resets the statistics counters of the (specified) WAN Bridge.
Set {
"Enabled": true,
"Port": "Interfaces.Physical.Network.LAN.EthernetSwitch.Ports.1"

}

- Modifies the status and configuration parameters of the (specified) WAN Bridge.


Services.Local.DHCP.Server.v4[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"InterfacesList": ["Interfaces.IP.Br0", "Interfaces.IP.Br1"]

}

Retrieves the status and configuration parameters in regards to the (specified) DHCPv4 Server.
Set {
"Enabled": true,
"InterfacesList": ["Interfaces.IP.Br0", "Interfaces.IP.Br1"]

}

- Modifies the status and configuration parameters of the (specified) DHCPv4 Server.


Services.Local.DHCP.Server.v4.Leases[edit]

Method Args Response Description
Add {
"Id": "Printer",
"Name": "Printer",
"IP": "192.168.1.100",
"MAC": "AA:BB:CC:00:11:22"

}

{
"Id": "Printer",

}

Adds a new DHCPv4 Server Lease.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "Printer",
"Name": "Printer",
"IP": "192.168.1.100",
"MAC": "AA:BB:CC:00:11:22",
"Type": "Dynamic",
"Expires": 0
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of DHCPv4 Server Leases.


Services.Local.DHCP.Server.v4.Leases.{LeaseId}[edit]

Method Args Response Description
Delete - - Deletes the specified DHCPv4 Server Lease.
Get - {
"Id": "Printer",
"Name": "Printer",
"IP": "192.168.1.100",
"MAC": "AA:BB:CC:00:11:22",
"Type": "Dynamic",
"Expires": 0

}

Retrieves the status and configuration parameters in regards to the (specified) DHCPv4 Server Lease.
Set {
"Name": "Printer",
"IP": "192.168.1.100",
"MAC": "AA:BB:CC:00:11:22"

}

- Modifies the status and configuration parameters of the (specified) DHCPv4 Server Lease.


Services.Local.DHCP.Server.v4.Pools[edit]

Method Args Response Description
Add {
"Id": "LAN",
"Name": "LAN",
"Description": "Private LAN.",
"Enabled": true,
"Status": "Inactive",
"Range": {
"Start": "192.168.1.100",
"End": "192.168.1.125"
},
"Type": "Persistent",
"Conditional": true

}

{
"Id": "LAN"

}

Adds a new DHCPv4 Server Pool.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "LAN",
"Name": "LAN",
"Description": "Private LAN.",
"Enabled": true,
"Status": "Inactive",
"Range": {
"Start": "192.168.1.100",
"End": "192.168.1.125"
},
"Type": "Persistent",
"Conditional": true
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of DHCPv4 Server Pools.


Services.Local.DHCP.Server.v4.Pools.{PoolId}[edit]

Method Args Response Description
Delete - - Deletes the specified DHCPv4 Server Pool.
Get - {
"Id": "LAN",
"Name": "LAN",
"Description": "Private LAN.",
"Enabled": true,
"Status": "Inactive",
"Range": {
"Start": "192.168.1.100",
"End": "192.168.1.125"
},
"Type": "Persistent",
"Conditional": true

}

Retrieves the status and configuration parameters in regards to the (specified) DHCPv4 Server Pool.
Set {
"Name": "LAN",
"Description": "Private LAN.",
"Enabled": true,
"Status": "Inactive",
"Range": {
"Start": "192.168.1.100",
"End": "192.168.1.125"
},
"Type": "Persistent",
"Conditional": true

}

- Modifies the status and configuration parameters of the (specified) DHCPv4 Server Pool.


Services.Local.DHCP.Server.v4.Pools.{PoolId}.Rules[edit]

Method Args Response Description
Add {
"Name": "STB",
"Enabled": true,
"Condition": {
"Option": 60,
"Type": "Equals",
"Value": "Arris200"
}

}

{
"Id": 0

}

Adds a new DHCPv4 Server Pool Conditional Rule.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Name": "STB",
"Enabled": true,
"Condition": {
"Option": 60,
"Type": "Equals",
"Value": "Arris200"
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of DHCPv4 Server Pool Conditional Rules.


Services.Local.DHCP.Server.v4.Pools.{PoolId}.Rules.{RuleId}[edit]

Method Args Response Description
Delete - - Deletes the specified DHCPv4 Server Pool Conditional Rule.
Get - {
"Id": 0,
"Name": "STB",
"Enabled": true,
"Condition": {
"Option": 60,
"Type": "Equals",
"Value": "Arris200"
}

}

Retrieves the status and configuration parameters in regards to the (specified) DHCPv4 Server Pool Conditional Rule.
Set {
"Name": "STB",
"Enabled": true,
"Condition": {
"Option": 60,
"Type": "Equals",
"Value": "Arris200"
}

}

- Modifies the status and configuration parameters of the (specified) DHCPv4 Server Pool Conditional Rule.


Services.Local.DNS.Dynamic[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Registered",
"ProviderId": "Services.Local.DynDNS.Providers.NoIP",
"InterfacesList": [
"Interfaces.IP.WAN_FTTH",
"Interfaces.IP.WAN_Mobile"
],
"RenewInterval": 3600,
"AdvertisePublicAddress": false

}

Retrieves the status and configuration parameters in regards to the (specified) Dynamic DNS.
Renew - - Forces a Dynamic DNS communication with the configured service provider.
Set {
"Enabled": true,
"ProviderId": "Services.Local.DynDNS.Providers.NoIP",
"InterfacesList": [
"Interfaces.IP.WAN_FTTH",
"Interfaces.IP.WAN_Mobile"
],
"RenewInterval": 3600,
"AdvertisePublicAddress": false

}

- Modifies the status and configuration parameters of the (specified) Dynamic DNS.


Services.Local.DNS.Dynamic.Providers[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "NoIP",
"Name": "No-Ip",
"Username": "john@no-ip.org",
"Password": "abc123",
"URL": "https://www.noip.com"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Dynamic DNS Service Providers.


Services.Local.DNS.Dynamic.Providers.{ProviderId}[edit]

Method Args Response Description
Get - {
"Id": "NoIP",
"Name": "No-Ip",
"Username": "john@no-ip.org",
"Password": "abc123",
"URL": "https://www.noip.com"

}

Retrieves the status and configuration parameters in regards to the (specified) Dynamic DNS Service Provider.
Set {
"Username": "john@no-ip.org",
"Password": "abc123"

}

- Modifies the status and configuration parameters of the (specified) Dynamic DNS Service Provider.


Services.Local.DNS.Multicast[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Name": "router",
"Domain": "local",
"Interface": "Interfaces.IP.Br0"

}

Retrieves the status and configuration parameters in regards to the (specified) Multicast DNS.
Set {
"Enabled": true,
"Name": "router",
"Domain": "local",
"Interface": "Interfaces.IP.Br0"

}

- Modifies the status and configuration parameters of the (specified) Multicast DNS.


Services.Local.DNS.Proxy[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"ForwardingMode": "Concurrent",
"InterfacesList": [
"Interfaces.IP.Br0",
"Interfaces.IP.Br1"
]

}

Retrieves the status and configuration parameters in regards to the (specified) DNS Proxy.
Set {
"Enabled": true,
"ForwardingMode": "Concurrent",
"InterfacesList": [
"Interfaces.IP.Br0",
"Interfaces.IP.Br1"
]

}

- Modifies the status and configuration parameters of the (specified) DNS Proxy.


Services.Local.DNS.Proxy.Domains[edit]

Method Args Response Description
Add {
"Id": 0,
"Name": "lan",
"Enabled": true

}

{
"Id": 0

}

Adds a new DNS Proxy Domain.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Name": "lan",
"Enabled": true
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of DNS Proxy Domains.


Services.Local.DNS.Proxy.Domains.{DomainId}[edit]

Method Args Response Description
Delete - - Deletes the specified DNS Proxy Domain.
Get - {
"Id": 0,
"Name": "lan",
"Enabled": true

}

Retrieves the status and configuration parameters in regards to the (specified) DNS Proxy Domain.
Set {
"Name": "lan",
"Enabled": true

}

- Modifies the status and configuration parameters of the (specified) DNS Proxy Domain.


Services.Local.DNS.Proxy.Domains.{DomainId}.Hosts[edit]

Method Args Response Description
Add {
"Id": 0,
"Name": "Printer",
"IP": "192.168.1.5",
"Type": "Static",
"Expires": 0

}

{
"Name": "Printer",
"IP": "192.168.1.5",
"Type": "Static",
"Expires": 0

}

Adds a new DNS Proxy Host.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Name": "Printer",
"IP": "192.168.1.5",
"Type": "Static",
"Expires": 0
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of DNS Proxy Hosts.


Services.Local.DNS.Proxy.Domains.{DomainId}.Hosts.{HostId}[edit]

Method Args Response Description
Delete - - Deletes the specified DNS Proxy Host.
Get - {
"Id": 0,
"Name": "Printer",
"IP": "192.168.1.5",
"Type": "Static",
"Expires": 0

}

Retrieves the status and configuration parameters in regards to the (specified) DNS Proxy Host.
Set {
"Name": "Printer",
"IP": "192.168.1.5",
"Type": "Static",
"Expires": 0

}

- Modifies the status and configuration parameters of the (specified) DNS Proxy Host.


Services.Local.DNS.Proxy.Forwarders[edit]

Method Args Response Description
Add {
"Enabled": true,
"Name": "VoIP",
"Address": "8.8.4.4",
"Priority": "2",
"Domain": "ims.prplFoundation.com"

}

{
"Id": 2

}

Adds a new DNS Proxy Forwarding Server.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 2,
"Enabled": true,
"Name": "VoIP",
"Address": "8.8.4.4",
"Priority": "2",
"Domain": "ims.prplFoundation.com"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of DNS Proxy Forwarding Servers.


Services.Local.DNS.Proxy.Forwarders.{ForwarderId}[edit]

Method Args Response Description
Delete - - Deletes the specified DNS Proxy Forwarding Server.
Get - {
"Id": 2,
"Enabled": true,
"Name": "VoIP",
"Address": "8.8.4.4",
"Priority": "2",
"Domain": "ims.prplFoundation.com"

}

Retrieves the status and configuration parameters in regards to the (specified) DNS Proxy Forwarding Server.
Set {
"Enabled": true,
"Name": "VoIP",
"Address": "8.8.4.4",
"Priority": "2",
"Domain": "ims.prplFoundation.com"

}

- Modifies the status and configuration parameters of the (specified) DNS Proxy Forwarding Server.


Services.Local.Firewall[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"ProfileId": "Services.Local.Firewall.Profiles.Low"

}

Retrieves the status and configuration parameters in regards to the (specified) Firewall.
Set {
"Enabled": true,
"ProfileId": "Services.Local.Firewall.Profiles.Low"

}

- Modifies the status and configuration parameters of the (specified) Firewall.


Services.Local.Firewall.Filter.Chains[edit]

Method Args Response Description
Add {
"Id": 0,
"Name": "System",
"Priority": 0,
"Enabled": true

}

{
"Id": 0

}

Adds a new Firewall Filter Chain.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Name": "System",
"Priority": 0,
"Enabled": true
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Firewall Filter Chains.


Services.Local.Firewall.Filter.Chains.{ChainId}[edit]

Method Args Response Description
Delete - - Deletes the specified Firewall Filter Chain.
Get - {
"Id": 0,
"Name": "System",
"Priority": 0,
"Enabled": true

}

Retrieves the status and configuration parameters in regards to the (specified) Firewall Filter Chain.
Set {
"Name": "System",
"Priority": 0,
"Enabled": true

}

- Modifies the status and configuration parameters of the (specified) Firewall Filter Chain.


Services.Local.Firewall.Filter.Chains.{ChainId}.Rules[edit]

Method Args Response Description
Add {
"Id": 1,
"Name": "HTTP",
"Enabled": true,
"Logging": false,
"IP": {
"Source": "192.168.1.4",
"Destination": null
},
"MAC": {
"Source": null,
"Destination": null
},
"Port": {
"Source": null,
"Destination": 8080
},
"Interface": {
"Source": "Interfaces.IP.LAN.Br0",
"Destination": null
},
"TransportProtocol": "TCP"

}

{
"Id": 1

}

Adds a new Firewall Rule.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 1,
"Name": "HTTP",
"Enabled": true,
"Logging": false,
"IP": {
"Source": "192.168.1.4",
"Destination": null
},
"MAC": {
"Source": null,
"Destination": null
},
"Port": {
"Source": null,
"Destination": 8080
},
"Interface": {
"Source": "Interfaces.IP.LAN.Br0",
"Destination": null
},
"TransportProtocol": "TCP",
"Statistics": {
"Hits": 0
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Firewal Rule Sets.
ResetStatistics - - Resets the statistics counters of the (specified) Firewall Rule.


Services.Local.Firewall.Filter.Chains.{ChainId}.Rules.{RuleId}[edit]

Method Args Response Description
Delete - - Deletes the specified Firewall Rule.
Get - {
"Id": 1,
"Name": "HTTP",
"Enabled": true,
"Logging": false,
"IP": {
"Source": "192.168.1.4",
"Destination": null
},
"MAC": {
"Source": null,
"Destination": null
},
"Port": {
"Source": null,
"Destination": 8080
},
"Interface": {
"Source": "Interfaces.IP.LAN.Br0",
"Destination": null
},
"TransportProtocol": "TCP",
"Statistics": {
"Hits": 0
}

}

Retrieves the status and configuration parameters in regards to the (specified) Firewall Rule.
ResetStatistics - - Resets the statistics counters of the (specified) Firewall Rule.
Set {
"Name": "HTTP",
"Enabled": true,
"Logging": false,
"IP": {
"Source": "192.168.1.4",
"Destination": null
},
"MAC": {
"Source": null,
"Destination": null
},
"Port": {
"Source": null,
"Destination": 8080
},
"Interface": {
"Source": "Interfaces.IP.LAN.Br0",
"Destination": null
},
"TransportProtocol": "TCP"

}

- Modifies the status and configuration parameters of the (specified) Firewall Rule.


Services.Local.Firewall.NAT.ALGs[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Name": "FTP",
"Port": 21,
"Enabled": true
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Firewall NAT ALGs.


Services.Local.Firewall.NAT.ALGs.{ALGId}[edit]

Method Args Response Description
Get - {
"Id": 0,
"Name": "FTP",
"Port": 21,
"Enabled": true

}

Retrieves the status and configuration parameters in regards to the (specified) Firewall NAT ALG.
Set {
"Port": 21,
"Enabled": true

}

- Modifies the status and configuration parameters of the (specified) Firewall NAT ALG.


Services.Local.Firewall.NAT.DMZ[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"MAC": "AA:BB:CC:00:11:22",
"Isolate": true,
"Subnet": "Services.Local.DHCP.Server.Pools.DMZ",
"Statistics": {
"Packets": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) DMZ.
Set {
"Enabled": true,
"MAC": "AA:BB:CC:00:11:22",
"Isolate": true,
"Subnet": "Services.Local.DHCP.Server.Pools.DMZ",
"Statistics": {
"Packets": {
"Transmitted": 0,
"Received": 0
},
"Bytes": {
"Transmitted": 0,
"Received": 0
}
}

}

- Modifies the status and configuration parameters of the (specified) DMZ.


Services.Local.Firewall.NAT.Rules[edit]

Method Args Response Description
Add {
"Id": 1,
"Enabled": true,
"Interface": [
"Interfaces.IP.WAN_FTTH"
],
"Template": "Services.Local.Firewall.NAT.Templates.SSH",
"IP": "192.168.1.5"

}

{
"Id": 1

}

Adds a new NAT Rule.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 1,
"Enabled": true,
"Interface": [
"Interfaces.IP.WAN_FTTH"
],
"Template": "Services.Local.Firewall.NAT.Templates.SSH",
"IP": "192.168.1.5"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of NAT Rules.


Services.Local.Firewall.NAT.Rules.{RuleId}[edit]

Method Args Response Description
Delete - - Deletes the specified NAT Rule.
Get - {
"Id": 1,
"Enabled": true,
"Interface": [
"Interfaces.IP.WAN_FTTH"
],
"Template": "Services.Local.Firewall.NAT.Templates.SSH",
"IP": "192.168.1.5"

}

Retrieves the status and configuration parameters in regards to the (specified) NAT Rule.
Set {
"Enabled": true,
"Interface": [
"Interfaces.IP.WAN_FTTH"
],
"Template": "Services.Local.Firewall.NAT.Templates.SSH",
"IP": "192.168.1.5"

}

- Modifies the status and configuration parameters of the (specified) NAT Rule.


Services.Local.Firewall.NAT.Templates[edit]

Method Args Response Description
Add {
"Id": "SSH",
"Name": "SSH",
"Port": {
"External": 22,
"Internal": 22
},
"Protocol": {
"TCP": true,
"UDP": false
}

}

{
"Id": "SSH"

}

Adds a new NAT Template.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "SSH",
"Name": "SSH",
"Port": {
"External": 22,
"Internal": 22
},
"Protocol": {
"TCP": true,
"UDP": false
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of NAT Templates.


Services.Local.Firewall.NAT.Templates.{TemplateId}[edit]

Method Args Response Description
Delete - - Deletes the specified NAT Template.
Get - {
"Id": "SSH",
"Name": "SSH",
"Port": {
"External": 22,
"Internal": 22
},
"Protocol": {
"TCP": true,
"UDP": false
}

}

Retrieves the status and configuration parameters in regards to the (specified) NAT Template.
Set {
"Name": "SSH",
"Port": {
"External": 22,
"Internal": 22
},
"Protocol": {
"TCP": true,
"UDP": false
}

}

- Modifies the status and configuration parameters of the (specified) NAT Template.


Services.Local.Firewall.NAT.UPnPIGD[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "active",
"Version": "2.0",
"Interface": "Interfaces.IP.br0"

}

Retrieves the status and configuration parameters in regards to the (specified) UPnP IGD.
Set {
"Enabled": true,
"Version": "2.0",
"Interface": "Interfaces.IP.br0"

}

- Modifies the status and configuration parameters of the (specified) UPnP IGD.


Services.Local.Firewall.Profiles[edit]

Method Args Response Description
Add {
"Id": "Low",
"Name": "Low",
"Description": "Provides minor Firewall protection.",
"Mode": "Blacklist",
"Chains": [
"Services.Local.Firewall.Filter.Chains.0",
"Services.Local.Firewall.Filter.Chains.1
]

}

{
"Id": "Low"

}

Adds a new Firewall Profile.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Name": "Low",
"Description": "Provides minor Firewall protection.",
"Mode": "Blacklist",
"Chains": [
"Services.Local.Firewall.Filter.Chains.0",
"Services.Local.Firewall.Filter.Chains.1"
]
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Firewall Profiles.


Services.Local.Firewall.Profiles.{ProfileId}[edit]

Method Args Response Description
Delete - - Deletes the specified Firewall Profile.
Get - {
"Id": "Low",
"Name": "Low",
"Description": "Provides minor Firewall protection.",
"Mode": "Blacklist",
"Chains": [
"Services.Local.Firewall.Filter.Chains.0",
"Services.Local.Firewall.Filter.Chains.1"
]

}

Retrieves the status and configuration parameters in regards to the (specified) Firewall Profile.
Set {
"Name": "Low",
"Description": "Provides minor Firewall protection.",
"Mode": "Blacklist",
"Chains": [
"Services.Local.Firewall.Filter.Chains.0",
"Services.Local.Firewall.Filter.Chains.1"
]

}

- Modifies the status and configuration parameters of the (specified) Firewall Profile.


Services.Local.Media.DLNA[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Version": "4.0",
"Hostname": "prplFoundation HGW",
"Media": {
"Audio": true,
"Video": true,
"Images": true
},
"Volume": "Interfaces.Physical.Data.USB.1",
"Statistics": {
"Files": {
"Total": 40,
"Audio": 20,
"Video": 10,
"Images": 10
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) DLNA Media Server.
Set {
"Enabled": true,
"Version": "4.0",
"Hostname": "prplFoundation HGW",
"Media": {
"Audio": true,
"Video": true,
"Images": true
},
"Volume": "Interfaces.Physical.Data.USB.1"

}

- Modifies the status and configuration parameters of the (specified) DLNA Media Server.


Services.Local.Media.FTP[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Port": 21,
"Mode": "Passive",
"Volume": "Interfaces.Physical.Data.USB.1"

}

Retrieves the status and configuration parameters in regards to the (specified) FTP Server.
Set {
"Enabled": true,
"Port": 21,
"Mode": "Passive",
"Volume": "Interfaces.Physical.Data.USB.1"

}

- Modifies the status and configuration parameters of the (specified) FTP Server.


Services.Local.Media.SMB[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Version": "3.1.1",
"Hostname": "prplFoundation HGW"

}

Retrieves the status and configuration parameters in regards to the (specified) SMB Server.
Set {
"Enabled": true,
"Version": "3.1.1",
"Hostname": "prplFoundation HGW"

}

- Modifies the status and configuration parameters of the (specified) SMB Server.


Services.Local.Media.SMB.Shares[edit]

Method Args Response Description
Add {
"Id": 0,
"Enabled": true,
"Name": "Media",
"Volume": "Interfaces.Physical.Data.USB.0",

}

{
"Id": 0

}

Adds a new SMB Server Share.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Enabled": true,
"Status": "Active",
"Name": "Media",
"Volume": "Interfaces.Physical.Data.USB.0",
"Statistics": {
"Files": 0,
"Folders": 0
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of SMB Server Shares.


Services.Local.Media.SMB.Shares.{ShareId}[edit]

Method Args Response Description
Delete - - Deletes the specified SMB Server Share.
Get - {
"Id": 0,
"Enabled": true,
"Status": "Active",
"Name": "Media",
"Volume": "Interfaces.Physical.Data.USB.0",
"Statistics": {
"Files": 0,
"Folders": 0
}

}

Retrieves the status and configuration parameters in regards to the (specified) SMB Server Share.
Set {
"Id": 0,
"Enabled": true,
"Name": "Media",
"Volume": "Interfaces.Physical.Data.USB.0",
"Statistics": {
"Files": 0,
"Folders": 0
}

}

- Modifies the status and configuration parameters of the (specified) SMB Server Share.


Services.Local.Media.UPnPAV[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Version": "1.1",
"Hostname": "prplFoundation HGW",
"Media": {
"Audio": true,
"Video": true,
"Images": true
},
"Volume": "Interfaces.Physical.Data.USB.1",
"Statistics": {
"Files": {
"Total": 40,
"Audio": 20,
"Video": 10,
"Images": 10
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) UPnP AV Media Server.
Set {
"Enabled": true,
"Version": "1.1",
"Hostname": "prplFoundation HGW",
"Media": {
"Audio": true,
"Video": true,
"Images": true
},
"Volume": "Interfaces.Physical.Data.USB.1"

}

- Modifies the status and configuration parameters of the (specified) UPnP AV Media Server.


Services.Local.QoS.Tagging[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active"

}

Retrieves the status and configuration parameters in regards to the (specified) QoS Tagging.
Set {
"Enabled": true

}

- Modifies the status and configuration parameters of the (specified) QoS Tagging.


Services.Local.QoS.Tagging.Rules[edit]

Method Args Response Description
Add {
"Id": 1,
"Name": "HTTP",
"Enabled": true,
"IP": {
"Source": null,
"Destination": null
},
"MAC": {
"Source": null,
"Destination": null
},
"Port": {
"Source": null,
"Destination": 80
},
"Interface": {
"Source": "Interfaces.IP.LAN.Br0",
"Destination": "Interfaces.IP.WAN.FTTH"
},
"TransportProtocol": "TCP",
"Tag": {
"DSCP": "AF12",
"P-Bit": null,
"WMM": null
}

}

{
"Id": 1

}

Adds a new QoS Tagging Rule.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 1,
"Name": "HTTP",
"Enabled": true,
"IP": {
"Source": null,
"Destination": null
},
"MAC": {
"Source": null,
"Destination": null
},
"Port": {
"Source": null,
"Destination": 80
},
"Interface": {
"Source": "Interfaces.IP.LAN.Br0",
"Destination": "Interfaces.IP.WAN.FTTH"
},
"TransportProtocol": "TCP",
"Tag": {
"DSCP": "AF12",
"P-Bit": null,
"WMM": null
},
"Statistics": {
"Hits": 0
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of QoS Tagging Rules.


Services.Local.QoS.Tagging.Rules.{RuleId}[edit]

Method Args Response Description
Delete - - Deletes the specified QoS Tagging Rule.
Get - {
"Id": 1,
"Name": "HTTP",
"Enabled": true,
"IP": {
"Source": null,
"Destination": null
},
"MAC": {
"Source": null,
"Destination": null
},
"Port": {
"Source": null,
"Destination": 80
},
"Interface": {
"Source": "Interfaces.IP.LAN.Br0",
"Destination": "Interfaces.IP.WAN.FTTH"
},
"TransportProtocol": "TCP",
"Tag": {
"DSCP": "AF12",
"P-Bit": null,
"WMM": null
},
"Statistics": {
"Hits": 0
}

}

Retrieves the status and configuration parameters in regards to the (specified) QoS Tagging Rule.
ResetStatistics Resets the statistics counters of the (specified) QoS Tagging Rule.
Set {
"Name": "HTTP",
"Enabled": true,
"IP": {
"Source": null,
"Destination": null
},
"MAC": {
"Source": null,
"Destination": null
},
"Port": {
"Source": null,
"Destination": 80
},
"Interface": {
"Source": "Interfaces.IP.LAN.Br0",
"Destination": "Interfaces.IP.WAN.FTTH"
},
"TransportProtocol": "TCP",
"Tag": {
"DSCP": "AF12",
"P-Bit": null,
"WMM": null
}

}

- Modifies the status and configuration parameters of the (specified) QoS Tagging Rule.


Services.Local.VPN.GRE[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Remote": {
"Address": "22.2.4.2"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) GRE Tunnel.
Set {
"Enabled": true,
"Remote": {
"Address": "22.2.4.2"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
}

}

- Modifies the status and configuration parameters of the (specified) GRE Tunnel.
ResetStatistics - - Resets the statistics counters of the (specified) GRE Tunnel.


Services.Local.VPN.IPSec.Client[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Remote": {
"Address": "22.2.4.2",
"Port": 50,
"Username": "prplFoundation",
"Password": "abc123",
"Authentication": "IKE"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) IPSec VPN Client.
ResetStatistics - - Resets the statistics counters of the (specified) IPSec VPN Client.
Set {
"Enabled": true,
"Remote": {
"Address": "22.2.4.2",
"Port": 50,
"Username": "prplFoundation",
"Password": "abc123",
"Authentication": "IKE"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
}

}

- Modifies the status and configuration parameters of the (specified) IPSec VPN Client.


Services.Local.VPN.IPSec.Server[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Server": {
"Port": 50,
"Authentication": "IKE",
"MTU": 1200,
"MaxClients": 1
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) IPSec VPN Server.
ResetStatistics - - Resets the statistics counters of the (specified) IPSec VPN Server.
Set {
"Enabled": true,
"Server": {
"Port": 50,
"Authentication": "IKE",
"MTU": 1200,
"MaxClients": 1
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
}

}

- Modifies the status and configuration parameters of the (specified) IPSec VPN Server.


Services.Local.VPN.L2TP.Client[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Remote": {
"Address": "22.2.4.2",
"Port": 1701,
"Username": "prplFoundation",
"Password": "abc123"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) L2TP VPN Client.
ResetStatistics - - Resets the statistics counters of the (specified) L2TP VPN Client.
Set {
"Enabled": true,
"Remote": {
"Address": "22.2.4.2",
"Port": 1701,
"Username": "prplFoundation",
"Password": "abc123"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
}

}

- Modifies the status and configuration parameters of the (specified) L2TP VPN Client.


Services.Local.VPN.L2TP.Server[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Server": {
"Port": 1701,
"MTU": 1200,
"MaxClients": 1
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) L2TP VPN Server.
ResetStatistics - - Resets the statistics counters of the (specified) L2TP VPN Server.
Set {
"Enabled": true,
"Server": {
"Port": 1701,
"MTU": 1200,
"MaxClients": 1
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
}

}

- Modifies the status and configuration parameters of the (specified) L2TP VPN Server.


Services.Local.VPN.OpenVPN.Client[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Remote": {
"Address": "22.2.4.2",
"Port": 1194,
"Protocol": "UDP",
"Username": "prplFoundation",
"Password": "abc123"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) OpenVPN Client.
ResetStatistics - - Resets the statistics counters of the (specified) OpenVPN Client.
Set {
"Enabled": true,
"Remote": {
"Address": "22.2.4.2",
"Port": 1194,
"Protocol": "UDP",
"Username": "prplFoundation",
"Password": "abc123"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

- Modifies the status and configuration parameters of the (specified) OpenVPN Client.


Services.Local.VPN.OpenVPN.Server[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Server": {
"Port": 1194,
"Protocol": "UDP",
"MTU": 1200,
"MaxClients": 1,
"Fragment": true
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) OpenVPN Server.
ResetStatistics - - Resets the statistics counters of the (specified) OpenVPN Server.
Set {
"Enabled": true,
"Server": {
"Port": 1194,
"Protocol": "UDP",
"MTU": 1200,
"MaxClients": 1,
"Fragment": true
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
}

}

- Modifies the status and configuration parameters of the (specified) OpenVPN Server.


Services.Local.VPN.PPTP.Client[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Remote": {
"Address": "22.2.4.2",
"Port": 1723,
"Username": "prplFoundation",
"Password": "abc123"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) PPTP Client.
ResetStatistics - - Resets the statistics counters of the (specified) PPTP Client.
Set {
"Enabled": true,
"Remote": {
"Address": "22.2.4.2",
"Port": 1723,
"Username": "prplFoundation",
"Password": "abc123"
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
}

}

- Modifies the status and configuration parameters of the (specified) PPTP Client.


Services.Local.VPN.PPTP.Server[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Server": {
"Port": 1723,
"MTU": 1200,
"MaxClients": 1
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
},
"Statistics": {
"Bytes": {
"Transmitted": 0,
"Received": 0
},
"Frames": {
"Transmitted": 0,
"Received": 0
}
}

}

Retrieves the status and configuration parameters in regards to the (specified) PPTP Server.
ResetStatistics - - Resets the statistics counters of the (specified) PPTP Server.
Set {
"Enabled": true,
"Server": {
"Port": 1723,
"MTU": 1200,
"MaxClients": 1
},
"Interfaces": {
"Outbound": "Interfaces.IP.ffth_dhcp",
"Inbound": "Interfaces.IP.br0"
}

}

Modifies the status and configuration parameters of the (specified) PPTP Server.


Services.Local.Wi-Fi.ACL[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Mode": "Blacklist"

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi MAC Address ACL.
Set {
"Enabled": true,
"Mode": "Blacklist"

}

- Modifies the status and configuration parameters of the (specified) Wi-Fi MAC Address ACL.


Services.Local.Wi-Fi.ACL.Stations[edit]

Method Args Response Description
Add {
"MAC": "AA:BB:CC:00:11:22"

}

{
"Id": 1

}

Adds a new Wi-Fi MAC Address ACL Station.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 1,
"MAC": "AA:BB:CC:00:11:22"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Wi-Fi MAC Address ACL Stations.


Services.Local.Wi-Fi.ACL.Stations.{StationId}[edit]

Method Args Response Description
Delete - - Deletes the specified Wi-Fi MAC Address ACL Station.
Get - {
"Id": 1,
"MAC": "AA:BB:CC:00:11:22"

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi MAC Address ACL Station.


Services.Local.Wi-Fi.Scheduler[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"Mode": "Blacklist"

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi Scheduler.
Set {
"Enabled": true,
"Mode": "Blacklist"

}

- Modifies the status and configuration parameters of the (specified) Wi-Fi Scheduler.


Services.Local.Wi-Fi.Scheduler.Rules[edit]

Method Args Response Description
Add {
"Id": 1,
"Name": "Kids",
"Enabled": true,
"Days": {
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": false,
"Sunday": false
},
"Time": {
"Start": "20h00",
"End": "07h00"
},
"BSSsList": [
"Wireless.Radio.24ghz.BSSs.Private",
"Wireless.Radio.5ghz.BSSs.Private"
],
"Host": "AA:BB:CC:00:11:22"

}

{
"Id": 1

}

Adds a new Wi-Fi Scheduler Rule.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 1,
"Name": "Kids",
"Enabled": true,
"Days": {
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": false,
"Sunday": false
},
"Time": {
"Start": "20h00",
"End": "07h00"
},
"BSSsList": [
"Wireless.Radio.24ghz.BSSs.Private",
"Wireless.Radio.5ghz.BSSs.Private"
],
"Host": "AA:BB:CC:00:11:22"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Wi-Fi Scheduler Rules.


Services.Local.Wi-Fi.Scheduler.Rules.{RuleId}[edit]

Method Args Response Description
Delete - - Deletes the specified Wi-Fi Scheduler Rule.
Get - {
"Id": 1,
"Name": "Kids",
"Enabled": true,
"Days": {
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": false,
"Sunday": false
},
"Time": {
"Start": "20h00",
"End": "07h00"
},
"BSSsList": [
"Wireless.Radio.24ghz.BSSs.Private",
"Wireless.Radio.5ghz.BSSs.Private"
],
"Host": "AA:BB:CC:00:11:22"

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi Scheduler Rule.
Set {
"Name": "Kids",
"Enabled": true,
"Days": {
"Monday": true,
"Tuesday": true,
"Wednesday": true,
"Thursday": true,
"Friday": true,
"Saturday": false,
"Sunday": false
},
"Time": {
"Start": "20h00",
"End": "07h00"
},
"BSSsList": [
"Wireless.Radio.24ghz.BSSs.Private",
"Wireless.Radio.5ghz.BSSs.Private"
],
"Host": "AA:BB:CC:00:11:22"

}

- Modifies the status and configuration parameters of the (specified) Wi-Fi Scheduler Rule.


Services.Local.Wi-Fi.WPS[edit]

Method Args Response Description
Get - {
"Enabled": false,
"Status": "Pairing",
"Mode": "Button",
"Timer": 120,
"BSSsList": [
"Wireless.Radios.24ghz.Private",
"Wireless.Radios.5ghz.Private"
]

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi WPS.
Set {
"Enabled": false,
"Mode": "Button",
"Timer": 120,
"BSSsList": [
"Wireless.Radios.24ghz.Private",
"Wireless.Radios.5ghz.Private"
]

}

- Modifies the status and configuration parameters of the (specified) Wi-Fi WPS.


Services.Local.Wi-Fi.WPS.PIN[edit]

Method Args Response Description
Generate - {
"PIN": 1234

}

Generates a new Wi-Fi WPS PIN.
Get - {
"PIN": 1234

}

Retrieves the status and configuration parameters in regards to the (specified) Wi-Fi WPS PIN.
Set {
"PIN": 1234

}

- Modifies the status and configuration parameters of the (specified) Wi-Fi WPS PIN.


Services.Local.Wi-Fi.WPS.Pairing[edit]

Method Args Response Description
Start - - Starts the Wi-Fi WPS Pairing Process.
Stop - - Stops the Wi-Fi WPS Pairing Process.


Services.Management.CWMP[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"PeriodicInform": {
"Enabled": true,
"Interval": 3600
},
"InterfacesList": [
"Interfaces.Networknterfaces.network.wan.xdsl.pvcs.035",
"interfaces.network.mobile"
],
"Mode": "Fallback"

}

Retrieves the status and configuration parameters in regards to the (specified) CWMP (TR-069) Client.
Set {
"Enabled": true,
"PeriodicInform": {
"Enabled": true,
"Interval": 3600
},
"InterfacesList": [
"Interfaces.Networknterfaces.network.wan.xdsl.pvcs.035",
"interfaces.network.mobile"
],
"Mode": "Fallback"

}

- Modifies the status and configuration parameters of the (specified) CWMP (TR-069) Client.


Services.Management.CWMP.ACS[edit]

Method Args Response Description
Get - {
"Server": "https://ACS.prplFoundation.com/CWMP",
"Port": 4444,
"Username": "prplFoundation",
"Password": "prplFoundation"

}

Retrieves the status and configuration parameters in regards to the (specified) CWMP (TR-069) Client ACS Settings.
Set {
"Server": "https://ACS.prplFoundation.com/CWMP",
"Port": 4444,
"Username": "prplFoundation",
"Password": "prplFoundation"

}

- Modifies the status and configuration parameters of the (specified) CWMP (TR-069) Client ACS Settings.


Services.Management.CWMP.ConnectionRequest[edit]

Method Args Response Description
Get - {
"URL": "https://23.14.2.1:3000/cwmpMngt",
"Port": 3000,
"Authentication": "MD5",
"Protocol": "HTTPS",
"Statistics": {
"RequestsCount": 32,
"LastRequest": "2017-10-04 14:12:30"
}

}

Retrieves the status and configuration parameters in regards to the (specified) CWMP (TR-069) Client Connection Request Settings.
Set {
"URL": "https://23.14.2.1:3000/cwmpMngt",
"Port": 3000,
"Authentication": "MD5",
"Protocol": "HTTPS"

}

- Modifies the status and configuration parameters of the (specified) CWMP (TR-069) Client Connection Request Settings.


Services.Management.MobileAgent[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active"

}

Retrieves the status and configuration parameters in regards to the (specified) Mobile App Agent.
Set {
"Enabled": true

}

- Modifies the status and configuration parameters of the (specified) Mobile App Agent.


Services.Management.MobileAgent.Certificate[edit]

Method Args Response Description
Generate {
"SignatureAlgorithm": "SHA256",
"RSA": 1024,
"Encoding": "Base64",
"Country": "DE",
"CommonName": "192.168.1.1",
"Organization": "prplFoundation",
"CA": null,
"Duration": 365

}

- Generates a new Mobile App Agent Certificate.
Get - {
"SignatureAlgorithm": "SHA256",
"RSA": 1024,
"Encoding": "Base64",
"Keys": {
"Public": "2a6571da26602a67be14ea8c5ab82349",
"Private": "2a6571da26602a67be14ea8c5ab82349"
},
"Country": "DE",
"CommonName": "192.168.1.1",
"Organization": "prplFoundation",
"CA": null,
"Valid": {
"From": "2017-09-11 09:31:42",
"To": "2018-09-11 09:31:42"
}

}

Retrieves the status and configuration parameters in regards to the (specified) Mobile App Agent Certificate.


Services.Management.MobileAgent.Client.Certificates[edit]

Method Args Response Description
Add {
"Encoding": "Base64",
"Hash": "2a6571da26602a67be14ea8c5ab82349",
"Status": "Pending",
"Timestamp": {
"Installed": "2017-09-11 09:31:42",
"LastUsed": "2017-09-13 10:23:11"
},
"Type": "MD5"

}

{
"Id": 1

}

Adds a new Mobile App Agent Client Certificate.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 1,
"Enabled": true,
"Encoding": "Base64",
"Hash": "2a6571da26602a67be14ea8c5ab82349",
"Status": "Pending",
"Timestamp": {
"Installed": "2017-09-11 09:31:42",
"LastUsed": "2017-09-13 10:23:11"
},
"Type": "MD5"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Mobile App Agent Client Certificates.


Services.Management.MobileAgent.Client.Certificates.{CertificateId}[edit]

Method Args Response Description
Delete - - Deletes the specified Mobile App Agent Client Certificate.
Get - {
"Id": 1,
"Enabled": true,
"Encoding": "Base64",
"Hash": "2a6571da26602a67be14ea8c5ab82349",
"Status": "Pending",
"Timestamp": {
"Installed": "2017-09-11 09:31:42",
"LastUsed": "2017-09-13 10:23:11"
},
"Type": "MD5"

}

Retrieves the status and configuration parameters in regards to the (specified) Mobile App Agent Client Certificate.
Set {
"Enabled": true

}

- Modifies the status and configuration parameters of the (specified) Mobile App Agent Client Certificate.


System.Buttons[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Name": "Wi-Fi",
"Enabled": true,
"Actions": {
"Click": {
"Object": "Interfaces.Physical.Network.LAN.Wi-Fi.Radios.24GHz",
"Method": "Set",
"Arguments": {
"Enabled": false
}
},
"Press": {
"Object": "Services.Local.Wi-Fi.WPS.Pairing",
"Method": "Start",
"Arguments": null
}
},
"Statistics": {
"Click": 0,
"Press": 0
}
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Buttons.


System.Buttons.{ButtonId}[edit]

Method Args Response Description
Get - {
"Id": 0,
"Name": "Wi-Fi",
"Enabled": true,
"Actions": {
"Click": {
"Object": "Interfaces.Physical.Network.LAN.Wi-Fi.Radios.24GHz",
"Method": "Set",
"Arguments": {
"Enabled": false
}
},
"Press": {
"Object": "Services.Local.Wi-Fi.WPS.Pairing",
"Method": "Start",
"Arguments": null
}
},
"Statistics": {
"Click": 0,
"Press": 0
}

}

Retrieves the status and configuration parameters in regards to the (specified) Button.
ResetStatistics - - Resets the statistics counters of the (specified) Button.
Set {
"Id": 0,
"Name": "Wi-Fi",
"Enabled": true,
"Actions": {
"Click": {
"Object": "Interfaces.Physical.Network.LAN.Wi-Fi.Radios.24GHz",
"Method": "Set",
"Arguments": {
"Enabled": false
}
},
"Press": {
"Object": "Services.Local.Wi-Fi.WPS.Pairing",
"Method": "Start",
"Arguments": null
}
}

}

- Modifies the status and configuration parameters of the (specified) Button.


System.Firmware[edit]

Method Args Response Description
Get - {
"ActiveImageId": "System.Firmware.Images.1",
"Status": "Installing",
"InstallTimestamp": "2017-08-12 11:32:22"

}

Retrieves the status and configuration parameters in regards to the (specified) Firmware Image.


System.Firmware.Images[edit]

Method Args Response Description
Add {
"Source": {
"Address": "fs.prplFoundation.com/devices.img",
"Port": 8080,
"Protocol": "HTTPS",
"Username": "prplFoundation",
"Password": "password"
},
"Load": false

}

{
"Id": 1

}

Adds a new Firmware Image.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 1,
"Status": "Downloaded",
"Variant": "DE",
"ReleaseDate": "2017-04-12",
"Version": "3.2.00",
"Source": {
"Address": "fs.prplFoundation.com/devices.img",
"Port": 8080,
"Protocol": "HTTPS",
"Username": "prplFoundation",
"Password": "password"
},
"DownloadTimestamp": "2017-08-12 11:32:22"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of Firmware Images.


System.Firmware.Images.{ImageId}[edit]

Method Args Response Description
Delete - - Deletes the specified Firmware Image.
Get - {
"Id": 1,
"Status": "Downloaded",
"Variant": "DE",
"ReleaseDate": "2017-04-12",
"Version": "3.2.00",
"Source": {
"Address": "fs.prplFoundation.com/devices.img",
"Port": 8080,
"Protocol": "HTTPS",
"Username": "prplFoundation",
"Password": "password"
},
"DownloadTimestamp": "2017-08-12 11:32:22"

}

Retrieves the status and configuration parameters in regards to the (specified) Firmware Image.
Load - - Loads the specified Firmware Image.


System.Hardware[edit]

Method Args Response Description
Get - {
"ProductClass": "Gateway",
"FriendlyName": "prplFoundation Essentials",
"Manufacturer": "prplManufacturer",
"Model": "H500t",
"Variant": "DE",
"CasingColour": "White",
"MAC": "AA:BB:CC:00:11:22",
"SerialNumber": "CP13856A32"

}

Retrieves the status and configuration parameters in regards to the (specified) System Hardware.


System.LEDs[edit]

Method Args Response Description
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "Broadband",
"Name:": "Internet",
"Enabled": true,
"Mode": "Fixed",
"Colour": "Red",
"Brightness": 0.80
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of LEDs.


System.LEDs.{LEDId}[edit]

Method Args Response Description
Get - {
"Id": "Broadband",
"Name:": "Internet",
"Enabled": true,
"Mode": "Fixed",
"Colour": "Red",
"Brightness": 0.80

}

Retrieves the status and configuration parameters in regards to the (specified) LED.
Set {
"Name:": "Internet",
"Enabled": true,
"Mode": "Fixed",
"Colour": "Red",
"Brightness": 0.80

}

- Modifies the status and configuration parameters of the (specified) LED.


System.Log[edit]

Method Args Response Description
Get - {
"Enabled": true,
"Status": "Active",
"MaximumEvents": 200,
"LevelFilter": "Warning"

}

Retrieves the status and configuration parameters in regards to the (specified) SysLog.
Set {
"Enabled": true,
"MaximumEvents": 200,
"LevelFilter": "Warning"

}

- Modifies the status and configuration parameters of the (specified) SysLog.


System.Log.Events[edit]

Method Args Response Description
Add {
"Level": "Information",
"Source": "Wi-Fi",
"Description": "Wi-Fi 5 GHz interface disabled."

}

{
"Id": 0

}

Adds a new SysLog Event.
Clear - - Clears all SysLog Events.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": 0,
"Timestamp": "2017-10-05 14h23h05",
"Level": "Information",
"Source": "Wi-Fi",
"Description": "Wi-Fi 5 GHz interface disabled."
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of SysLog Events.


System.Log.Events.{EventId}[edit]

Method Args Response Description
Get - {
"Id": 0,
"Timestamp": "2017-10-05 14h23h05",
"Level": "Information",
"Source": "Wi-Fi",
"Description": "Wi-Fi 5 GHz interface disabled."

}

Retrieves the status and configuration parameters in regards to the (specified) SysLog Event.


System.Resources[edit]

Method Args Response Description
Get - {
"CPU": {
"Usage": 0.4,
"Load": {
"1m": 0.09,
"5m": 0.05,
"15m": 0.01
}
},
"Memory": {
"Total": 64000,
"Free": 32000,
"Usage": 0.70
},
"Swap": {
"Total": 32000,
"Free": 16000,
"Usage": 0.50
},
"Storage": {
"Total": 256000000,
"Free": 128000000,
"Usage": 0.50
},
"Uptime": 12321

}

Retrieves the status and configuration parameters in regards to the (specified) System Resources.


System.Settings[edit]

Method Args Response Description
Get - {
"AutoSave": {
"Enabled": true,
"Interval": 3600
},
"RunningId": "System.Settings.Configuration.1",
"StartupId": "System.Settings.Configuration.1",
"FactoryDefaultId": "System.Settings.Configuration.0"

}

Retrieves the status and configuration parameters in regards to the (specified) System Settings.
Set {
"AutoSave": {
"Enabled": true,
"Interval": 3600
},
"StartupId": "System.Settings.Configuration.1"

}

- Modifies the status and configuration parameters of the (specified) System Settings.


System.Settings.Configurations[edit]

Method Args Response Description
Add {
"Source": {
"Address": "192.168.1.5/backup.cfg",
"Port": 80,
"Protocol": "HTTPS",
"Username": null,
"Password": "null"
},
"Load": true

}

{
"Id": 1

}

Adds a new System Settings Configuration.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "Default",
"Name": "Factory Default",
"Description": "Factory default settings.",
"Status": "Downloaded",
"Timestamp": "2017-09-12 14:32:10"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of System Settings Configurations.


System.Settings.Configurations.{ConfigurationId}[edit]

Method Args Response Description
Backup {
"Name": "Factory Default",
"Description": "Factory default settings."

}

{
"Id": "Backup"

}

Creates a copy (backup) of the specified System Settings.
Delete - - Deletes the specified System Settings Configuration.
Get - {
"Id": "Default",
"Name": "Factory Default",
"Description": "Factory default settings.",
"Status": "Downloaded",
"Timestamp": "2017-09-12 14:32:10"

}

Retrieves the status and configuration parameters in regards to the (specified) System Settings Configuration.
Load - - Loads the specified System Settings Configuration.
Set {
"Name": "Factory Default",
"Description": "Factory default settings."

}

- Modifies the status and configuration parameters of the (specified) System Settings Configuration.


User.Accounts[edit]

Method Args Response Description
Add {
"Id": "Admin",
"Enabled": True,
"Username": "Administrator",
"Password": "prplFoundation",
"Description": "Home-Gateway administrator."
"RoleId": "User.Roles.Root"

}

{
"Id": "Admin"

}

Adds a new User Account.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "Admin",
"Enabled": True,
"Username": "Administrator",
"Password": "prplFoundation",
"Description": "Home-Gateway administrator.",
"RoleId": "User.Roles.Root"
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of User Accounts.


User.Accounts.{AccountId}[edit]

Method Args Response Description
Delete - - Deletes the specified User Account.
Get - {
"Id": "Admin",
"Enabled": True,
"Username": "Administrator",
"Password": "prplFoundation",
"Description": "Home-Gateway administrator."
"RoleId": "User.Roles.Root"

}

Retrieves the status and configuration parameters in regards to the (specified) User Account.
Set {
"Username": "Administrator",
"Enabled": True,
"Password": "prplFoundation",
"Description": "Home-Gateway administrator."
"RoleId": "User.Roles.Root"

}

- Modifies the status and configuration parameters of the (specified) User Account.


User.Profile[edit]

Method Args Response Description
Get - {
"Type": "Consumer"

}

Retrieves the status and configuration parameters in regards to the (specified) User Profile.
Set {
"Type": "Consumer"

}

- Modifies the status and configuration parameters of the (specified) User Profile.


User.Roles[edit]

Method Args Response Description
Add {
"Id": "Root",
"Name": "Root",
"Description": "Root access to the system."

}

{
"Id": "Root"

}

Adds a new User Role.
List {
"Limit": 10,
"Offset": 0

}

{
"List": [
{
"Id": "root",
"Name": "Root",
"Description": "Root access to the system."
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of User Roles.


User.Roles.{RoleId}[edit]

Method Args Response Description
Delete - - Deletes the specified User Role.
Get - {
"Id": "Root",
"Name": "Root",
"Description": "Root access to the system."

}

Retrieves the status and configuration parameters in regards to the (specified) User Role.
Set {
"Name": "Root",
"Description": "Root access to the system."

}

- Modifies the status and configuration parameters of the (specified) User Role.


User.Roles.{RoleId}.ACL.Rules[edit]

Method Args Response Description
Add {
"Id": "WUI",
"Enabled": True,
"ServiceId": "Services.Management.WUI",
"AllowedZones": [
"WAN",
"LAN",
"WLANPrivate",
"WLANGuest"
"DMZ",
"Bridge"
]

}

{
"Id": "WUI"

}

Adds a new User Role ACL Rule.
List {
"Limit": 10,
"Offset": 0

}

{
"RulesList": [
{
"Id": "WUI",
"Enabled": True,
"ServiceId": "Services.Management.WUI",
"AllowedZones": [
"WAN",
"LAN",
"WLANPrivate",
"WLANGuest",
"DMZ",
"Bridge"
]
}
],
"Limit": 10,
"Offset": 0

}

Retrieves a list of User Role ACL Rules.


User.Roles.{RoleId}.ACL.Rules.{RuleId}[edit]

Method Args Response Description
Delete - - Deletes the specified User Role ACL Rule.
Get - {
"Id": "WUI",
"Enabled": True,
"ServiceId": "Services.Management.WUI",
"AllowedZones": [
"WAN",
"LAN",
"WLANPrivate",
"WLANGuest"
"DMZ",
"Bridge"
]

}

Retrieves the status and configuration parameters in regards to the (specified) User Role ACL Rule.
Set {
"Enabled": True,
"ServiceId": "Services.Management.WUI",
"AllowedZones": [
"WAN",
"LAN",
"WLANPrivate",
"WLANGuest"
"DMZ",
"Bridge"
]

}

- Modifies the status and configuration parameters of the (specified) User Role ACL Rule.