DOCS / API REFERENCE

List firewall rules

GET /v1/fences

GETHenHouse API v1

Request

GET /v1/fences

Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.

Parameters

NameTypeDescription
coop_idstringThe coop to read
directionstringinbound or outbound

Example

curl -X GET https://api.pollosoft.example/v1/fences?coop_id=example&direction=example \
  -H "Authorization: Bearer $COOP_TOKEN"

Response

A successful call returns 200 OK with JSON like this:

{
  "data": [
    {
      "id": "fr_91c",
      "action": "allow",
      "port": 443,
      "from": "203.0.113.0/24"
    }
  ],
  "has_more": false
}

Errors

IdempotencyThis endpoint is safe to retry. Reads do not lay eggs.