FlowGuard

Use the FlowGuard REST API to query request logs and manage your team's rules, actions, proxies, and IP lists.

Looking for help with the proxy or control plane? Go to the FlowGuard documentation.

Make your first request

Every request needs a bearer access token. Use a team access token for a service owned by one team, a personal access token for a private script, or OAuth when your application connects other users' accounts. The token guide explains how to create and protect each token type.

Give the token only the FlowGuard scopes its requests need. The production API base URL is:

Code
https://flowguard.network/api/v1

Start by retrieving the rule capabilities for the current API. This read-only request needs flowguard:rules:read:

Code
GET /api/v1/rules/capabilities HTTP/1.1
Host: flowguard.network
Authorization: Bearer $TOKEN
Accept: application/json

The response lists the supported condition operators, match types, action results, server scope modes, and maximum rule-group depth. Use it when building a rule editor instead of hard-coding those values.

API documentation