List the feeds and their state
GET /api/feeds
Needs a Viewer or Admin key.
subsystemEnabled is the master switch: when it is off, no feed is fetched whatever its own setting. enforcedRanges is how many address ranges the feeds are blocking now.
Replies
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | FeedsView |
Reply fields
| Field | Type | Description |
|---|---|---|
subsystemEnabled |
boolean | The threat-intelligence master switch. While it is off no feed is downloaded or enforced, whatever each feed's own setting. Always present. |
enforcedRanges |
integer | How many address ranges the feeds are blocking now, after your allowlist is taken out. Always present. |
feeds |
list of FeedView |
Every built-in feed and its state. Always present. |
Turn the feeds on or off
PUT /api/feeds/settings
Needs an Admin key.
The master switch. When it is off no feed is fetched or enforced, whatever each feed's own setting.
Request body: FeedSubsystemUpdate
| Field | Type | Description |
|---|---|---|
enabled |
boolean | True to turn threat-intelligence feeds on, false to turn them all off. |
Replies
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | SwitchState |
Reply fields
| Field | Type | Description |
|---|---|---|
enabled |
boolean | Whether the switch is now on. Always present. |
Turn one feed on or off, or change its action
PUT /api/feeds/{id}
Needs an Admin key.
action is Drop (blocked at the firewall), Challenge (sent to the browser check) or DetectionOnly (recorded only).
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
id |
path | string | Required. |
Request body: FeedUpdate
| Field | Type | Description |
|---|---|---|
enabled |
boolean | Whether this feed is switched on. A feed does nothing while the master switch is off, whatever this says. |
action |
FeedAction |
What happens to addresses the feed lists: Drop, DetectionOnly or Challenge. Drop is the default for a feed that has not been set. Required. One of Drop, DetectionOnly, Challenge. |
Replies
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | FeedStatus |
| 404 | Not Found | ApiError |
Reply fields
| Field | Type | Description |
|---|---|---|
feedId |
string | The feed's ID. Always present. |
enabled |
boolean | Whether the feed is switched on. Always present. |
action |
FeedAction |
What happens to addresses the feed lists: Drop, DetectionOnly or Challenge. Always present. One of Drop, DetectionOnly, Challenge. |
entryCount |
integer | How many addresses or ranges the last refresh loaded. 0 before the first refresh. Always present. |
lastRefreshedAt |
date-time | When the feed was last downloaded. Null until the first refresh. |
lastRefreshOk |
boolean | True when the last refresh worked. Always present. |
lastError |
string | Why the last refresh failed. Null when it worked or has not run yet. |
Updated 2026-10-27Something unclear or missing? Tell us.