Skip to content

Latest commit

 

History

History
133 lines (105 loc) · 2.33 KB

RESTAPI.md

File metadata and controls

133 lines (105 loc) · 2.33 KB

PureNAS REST API Documentation

Authentication

If specified as non empty in config, all API requests requires an API key passed as query parameter: ?key=YOUR_API_KEY at end. For example: api/system/info?key=changeme

Base URL

/api/

Endpoints

Subscriber Management

Get all subscribers

GET /api/subscriber/getall

Get subscribers waiting for authorization Returns IPs in the waitauth set (unknown subscribers) with MAC from local ARP when available. Requires UNAUTH_DETECTION_ENABLED=YES.

GET /api/subscriber/getwaitauth

Allow subscriber

GET /api/subscriber/allow/172.16.0.4

Disallow subscriber

GET /api/subscriber/disallow/172.16.0.4

Shape subscriber bandwidth

GET /api/subscriber/shape/172.16.0.4/1000
GET /api/subscriber/shape/172.16.0.4/1000/500

Parameters: IP, download (kbit/s), upload (kbit/s, optional)

Unshape subscriber

GET /api/subscriber/unshape/172.16.0.4

IP+MAC binding

Add IP+MAC binding (static ARP and/or FW_MACFIX)

GET /api/subscriber/mac/172.16.0.4/aa:bb:cc:dd:ee:ff

Remove IP+MAC binding

GET /api/subscriber/unmac/172.16.0.4

Ban / Unban (IP and ICMP)

Ban IP or CIDR (full block)

GET /api/ban/ip/1.2.3.4
GET /api/ban/ip/10.0.0.0/24

Unban IP or CIDR

GET /api/unban/ip/1.2.3.4
GET /api/unban/ip/10.0.0.0/24

Ban ICMP for IP or CIDR

GET /api/ban/icmp/1.2.3.4
GET /api/ban/icmp/10.0.0.0/24

Unban ICMP

GET /api/unban/icmp/1.2.3.4
GET /api/unban/icmp/10.0.0.0/24

System Information

Get system info

GET /api/system/info

Response Format

All responses are JSON. Success responses contain data, error responses contain error field.

Example Responses

subscriber/getall response:

{
  "172.16.0.4": {
    "ip": "172.16.0.4",
    "state": "ACTIVE",
    "mac": "aa:bb:cc:dd:ee:ff",
    "ratedown": "100 Mbit",
    "rateup": "50 Mbit",
    "hits": 1234
  }
}

subscriber/allow Action response:

{
  "success": true,
  "output": "== Added 172.16.0.4 to allowed_clients set =="
}

subscriber/getwaitauth response:

{
  "success": true,
  "waitauth": [
    { "ip": "172.16.0.50", "mac": "aa:bb:cc:dd:ee:ff" },
    { "ip": "172.16.0.51", "mac": "" }
  ]
}

mac is empty string when not found in the local ARP table.