# Rules

A rule is a policy used to manage access control traffic on your network and devices. Each rule either blocks, allows, or time limits traffic matching a certain target and a certain device or set of devices. Rules can also have custom schedules. The targets for the rules can be applications, target lists, network flow information (IPs, domains, ports), Internet access, local networks, or activity categories (gaming, adult, video, etc.).

# Get Rules MSP 2.7.0 or later

Gets all rules with given conditions.

GET https://msp_domain/v2/rules

Parameters

Name	Value
Authorization required	Personal access token

Name	Value
query	The search query. See Query basics

Response

200 Success

Name	Type	Description
`count`	Number	Number of results in the response
`results`	Rule[]	List of rules being returned, it returns all matched rules for now

{
  "count": 1,
  "results": [
      {
            "id": "00000000-0000-0000-0000-000000000001",
            "action": "allow",
            "direction": "bidirection",
            "gid": "00000000-0000-0000-0000-000000000000",
            "notes": "",
            "status": "active",
            "ts": 1730447709.791,
            "target": {
                "type": "domain",
                "value": "firewalla.com",
                "dnsOnly": true
            },
            "scope": {
                "type": "device",
                "value": "AA:BB:CC:DD:EE:FF"
            }
        }
  ]
}

401 Permission Denied

Examples

// https://github.com/axios/axios
const axios = require("axios");

// Change these variables to what you have
const msp_domain = process.env.msp_domain || "mydomain.firewalla.net";
const token = process.env.token || "your_personal_access_token";
const gid = "00000000-0000-0000-0000-000000000000";

axios({
    method: "get",
    url: `https://${msp_domain}/v2/rules?query=box.id:${gid}`,
    headers: {
        "Authorization": `Token ${token}`
    }
}).then(res => {
    console.log(res.data);
})

curl --request GET  \
--url "https://${msp_domain}/v2/rules?query=box.id:00000000-0000-0000-0000-000000000000" \
--header "Authorization: Token ${your_personal_access_token}"

# Pause A Rule

This API pauses an existing rule. The Rule ID can be found by navigating to the Rules page in MSP, clicking a rule, then scrolling to the bottom of the dialog.

POST https://msp_domain/v2/rules/:id/pause

Name	Value
Authorization required	Personal access token

Name	Value
id required	Rule ID

Response

200 Success

401 Permission Denied

404 Not Found

Examples

Pause An Existing Rule

// https://github.com/axios/axios
const axios = require("axios");

// Change these variables to what you have
const msp_domain = process.env.msp_domain || "mydomain.firewalla.net";
const token = process.env.token || "your_personal_access_token";
const gid = "00000000-0000-0000-0000-000000000000";
const id = 1;

axios({
    method: "post",
    url: `https://${msp_domain}/v2/rules/${id}/pause`,
    headers: {
        "Authorization": `Token ${token}`
    }
}).then(res => {
    console.log(res.data);
})

curl --request POST  \
--url "https://${msp_domain}/v2/rules/${id}/pause" \
--header "Authorization: Token ${your_personal_access_token}"

# Resume A Rule

This API resumes an existing rule. The Rule ID can be found by navigating to the Rules page in MSP, clicking a rule, then scrolling to the bottom of the dialog.

POST https://msp_domain/v2/rules/:id/resume

Name	Value
Authorization required	Personal access token

Name	Value
id required	Rule ID

Response

200 Success

401 Permission Denied

404 Not Found

Examples

// https://github.com/axios/axios
const axios = require("axios");

// Change these variables to what you have
const msp_domain = process.env.msp_domain || "mydomain.firewalla.net";
const token = process.env.token || "your_personal_access_token";
const gid = "00000000-0000-0000-0000-000000000000";
const id = 1;

axios({
    method: "post",
    url: `https://${msp_domain}/v2/rules/${id}/resume`,
    headers: {
        "Authorization": `Token ${token}`
    }
}).then(res => {
    console.log(res.data);
})

curl --request POST  \
--url "https://${msp_domain}/v2/rules/${id}/resume" \
--header "Authorization: Token ${your_personal_access_token}"