Rules

Download schema

Endpoints for discovering and managing FlowGuard request-matching rules.

Show rule capabilities

GET

https://flowguard.network/api/v1

/rules/capabilities

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Return the condition operators, match types, action results, server scope modes, and nesting limit supported by the current FlowGuard API. Use these capabilities to construct valid rule payloads.

Show rule capabilities › Responses

The rule language and action capabilities supported by the current API.

object · required

GET/rules/capabilities

curl https://flowguard.network/api/v1/rules/capabilities \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "condition_operators": [
      {
        "value": "value",
        "label": "label"
      }
    ],
    "condition_types": [
      {
        "value": "value",
        "label": "label",
        "matches": [
          "string"
        ],
        "requires_key": true,
        "additional_options": [
          "string"
        ]
      }
    ],
    "behavior_metrics": [
      {
        "value": "value",
        "label": "label"
      }
    ],
    "action_results": [
      {
        "value": "value",
        "label": "label",
        "default_status_code": 0,
        "default_message": "default_message"
      }
    ],
    "server_scope_modes": [
      {
        "value": "value",
        "label": "label"
      }
    ],
    "max_group_depth": 0
  }
}

json

application/json

List rules

GET

https://flowguard.network/api/v1

/rules

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List the authenticated team's rules in evaluation order. A lower position is evaluated first. Results can be searched by name and are paginated.

List rules › query Parameters

query

string | null · maxLength: 255

Search results by name.

per_page

integer · min: 1 · max: 100

Number of results per page.

Default: 50

page

integer · min: 1

Page number to return.

Default: 1

List rules › Responses

Array of Rule

Rule[] · required

GET/rules

curl https://flowguard.network/api/v1/rules \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "rule_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "Protect synthetic service",
      "position": 0,
      "action_id": "action_id",
      "conditions": {
        "operator": "operator",
        "matches": [
          {
            "type": "type",
            "match": "match",
            "key": "key",
            "value": "value",
            "values": [
              "string"
            ],
            "confidence": 0,
            "case_insensitive": true,
            "raw_match": true
          }
        ],
        "groups": [
          {
            "key": {}
          }
        ]
      },
      "server_scope": {
        "mode": "mode",
        "server_ids": [
          "string"
        ]
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    }
  ]
}

json

application/json

Create a rule

POST

https://flowguard.network/api/v1

/rules

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Create a rule for the authenticated team. The optional action must belong to the same team. A supplied zero-based position inserts the rule at that point and shifts later rules down; when omitted, the rule is appended.

Create a rule › Request Body

SaveRuleRequest

name

string · maxLength: 255 · required

Human-readable rule name.

Example: Protect synthetic service

object · required

Recursive condition group. Each group contains an AND or OR operator, a list of matches, and nested groups. Consult the rule capabilities endpoint for supported match types and operators.

Example: {"operator":"AND","matches":[{"type":"domain","match":"equals","value":"service.example.test"}],"groups":[]}

object · required

Server scope controlling which proxies evaluate the rule.

action_id

string | null

Formatted ID of an action owned by the authenticated team. Send null for a match-only rule.

position

integer · min: 0

Zero-based evaluation position. Omit when creating to append the rule; omit when updating to retain its current position.

Example: 0

Create a rule › Responses

The rule was created.

Rule · required

POST/rules

curl https://flowguard.network/api/v1/rules \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Protect synthetic service",
  "action_id": "action_id",
  "conditions": {
    "operator": "AND",
    "matches": [
      {
        "type": "domain",
        "match": "equals",
        "value": "service.example.test"
      }
    ],
    "groups": []
  },
  "server_scope": {
    "mode": "all",
    "server_ids": [
      "string"
    ]
  },
  "position": 0
}'

Example Request Body

{
  "name": "Protect synthetic service",
  "action_id": "action_id",
  "conditions": {
    "operator": "AND",
    "matches": [
      {
        "type": "domain",
        "match": "equals",
        "value": "service.example.test"
      }
    ],
    "groups": []
  },
  "server_scope": {
    "mode": "all",
    "server_ids": [
      "string"
    ]
  },
  "position": 0
}

json

Example Responses

{
  "data": {
    "id": "rule_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "name": "Protect synthetic service",
    "position": 0,
    "action_id": "action_id",
    "conditions": {
      "operator": "operator",
      "matches": [
        {
          "type": "type",
          "match": "match",
          "key": "key",
          "value": "value",
          "values": [
            "string"
          ],
          "confidence": 0,
          "case_insensitive": true,
          "raw_match": true
        }
      ],
      "groups": [
        {
          "key": {}
        }
      ]
    },
    "server_scope": {
      "mode": "mode",
      "server_ids": [
        "string"
      ]
    },
    "created_at": "created_at",
    "updated_at": "updated_at"
  }
}

json

application/json

Show a rule

GET

https://flowguard.network/api/v1

/rules/{rule}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show one rule belonging to the authenticated team, including its conditions, action, server scope, and evaluation position.

Show a rule › path Parameters

rule

string · required

Show a rule › Responses

Rule

Rule · required

GET/rules/{rule}

curl https://flowguard.network/api/v1/rules/:rule \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "rule_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "name": "Protect synthetic service",
    "position": 0,
    "action_id": "action_id",
    "conditions": {
      "operator": "operator",
      "matches": [
        {
          "type": "type",
          "match": "match",
          "key": "key",
          "value": "value",
          "values": [
            "string"
          ],
          "confidence": 0,
          "case_insensitive": true,
          "raw_match": true
        }
      ],
      "groups": [
        {
          "key": {}
        }
      ]
    },
    "server_scope": {
      "mode": "mode",
      "server_ids": [
        "string"
      ]
    },
    "created_at": "created_at",
    "updated_at": "updated_at"
  }
}

json

application/json

Update a rule

PATCH

https://flowguard.network/api/v1

/rules/{rule}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Update a rule belonging to the authenticated team. Omitted top-level fields retain their current values. Set action_id to null to detach the action; changing position reorders the team's rules.

Update a rule › path Parameters

rule

string · required

Update a rule › Request Body

SaveRuleRequest

name

string · maxLength: 255 · required

Human-readable rule name.

Example: Protect synthetic service

object · required

Recursive condition group. Each group contains an AND or OR operator, a list of matches, and nested groups. Consult the rule capabilities endpoint for supported match types and operators.

Example: {"operator":"AND","matches":[{"type":"domain","match":"equals","value":"service.example.test"}],"groups":[]}

object · required

Server scope controlling which proxies evaluate the rule.

action_id

string | null

Formatted ID of an action owned by the authenticated team. Send null for a match-only rule.

position

integer · min: 0

Zero-based evaluation position. Omit when creating to append the rule; omit when updating to retain its current position.

Example: 0

Update a rule › Responses

Rule

Rule · required

PATCH/rules/{rule}

curl https://flowguard.network/api/v1/rules/:rule \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Protect synthetic service",
  "action_id": "action_id",
  "conditions": {
    "operator": "AND",
    "matches": [
      {
        "type": "domain",
        "match": "equals",
        "value": "service.example.test"
      }
    ],
    "groups": []
  },
  "server_scope": {
    "mode": "all",
    "server_ids": [
      "string"
    ]
  },
  "position": 0
}'

Example Request Body

{
  "name": "Protect synthetic service",
  "action_id": "action_id",
  "conditions": {
    "operator": "AND",
    "matches": [
      {
        "type": "domain",
        "match": "equals",
        "value": "service.example.test"
      }
    ],
    "groups": []
  },
  "server_scope": {
    "mode": "all",
    "server_ids": [
      "string"
    ]
  },
  "position": 0
}

json

Example Responses

{
  "data": {
    "id": "rule_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "name": "Protect synthetic service",
    "position": 0,
    "action_id": "action_id",
    "conditions": {
      "operator": "operator",
      "matches": [
        {
          "type": "type",
          "match": "match",
          "key": "key",
          "value": "value",
          "values": [
            "string"
          ],
          "confidence": 0,
          "case_insensitive": true,
          "raw_match": true
        }
      ],
      "groups": [
        {
          "key": {}
        }
      ]
    },
    "server_scope": {
      "mode": "mode",
      "server_ids": [
        "string"
      ]
    },
    "created_at": "created_at",
    "updated_at": "updated_at"
  }
}

json

application/json

Delete a rule

DELETE

https://flowguard.network/api/v1

/rules/{rule}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Delete a rule belonging to the authenticated team and close the gap in the remaining evaluation positions.

Delete a rule › path Parameters

rule

string · required

Delete a rule › Responses

The rule was deleted.

string

Disable a rule

POST

https://flowguard.network/api/v1

/rules/{rule}/disable

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Remove the action assigned to a rule belonging to the authenticated team. The rule and its conditions remain available for later use.

Disable a rule › path Parameters

rule

string · required

Disable a rule › Responses

Rule

Rule · required

POST/rules/{rule}/disable

curl https://flowguard.network/api/v1/rules/:rule/disable \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "rule_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "name": "Protect synthetic service",
    "position": 0,
    "action_id": "action_id",
    "conditions": {
      "operator": "operator",
      "matches": [
        {
          "type": "type",
          "match": "match",
          "key": "key",
          "value": "value",
          "values": [
            "string"
          ],
          "confidence": 0,
          "case_insensitive": true,
          "raw_match": true
        }
      ],
      "groups": [
        {
          "key": {}
        }
      ]
    },
    "server_scope": {
      "mode": "mode",
      "server_ids": [
        "string"
      ]
    },
    "created_at": "created_at",
    "updated_at": "updated_at"
  }
}

json

application/json

Logs Actions