Build With the API

Call the four pfSense Actions routes with personal access tokens, read every status code, and connect scripts and shortcuts.

Request Basics

Authenticate pfSense Actions API requests with a Bearer personal access token, send JSON bodies to the /api/v1 routes, and read JSON results and errors.

Connectivity and System

Test the SSH sign-in to pfSense with GET /api/v1/connectivity, and read the firewall's operating system, release, and architecture with GET /api/v1/system.

Reachability Check

Ask pfSense to ping one IP address with POST /api/v1/ping, set how many five-packet attempts it can make, and interpret the 200, 502, and 503 results.

Wake-on-LAN

Wake a sleeping device with POST /api/v1/wol by sending its MAC address and subnet broadcast address, and learn what a 200 response does and doesn't confirm.

Status Codes and Limits

Look up every HTTP status and error code the pfSense Actions API returns, the order its checks run in, per-client rate limits and headers, and retry rules.

Automation Clients

Download a ready-made Mac Wake-on-LAN script, call pfSense Actions from a shell script, Shortcuts, or Home Assistant, and handle each status code.