Actions

Download schema

Endpoints for managing the actions FlowGuard applies when rules match.

List actions

GET

https://flowguard.network/api/v1

/actions

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List the authenticated team's reusable rule actions, newest first. Results can be searched by name and include the number of rules using each action.

List actions › 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 actions › Responses

Array of Action

Action[] · required

Create an action

POST

https://flowguard.network/api/v1

/actions

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Create a reusable action for the authenticated team. The selected result determines which configuration fields are applicable; consult the rule capabilities endpoint for supported results and defaults.

Create an action › Request Body

SaveActionRequest

name

string · maxLength: 255 · required

Human-readable action name.

Example: Block synthetic scanners

result

string · enum · required

Result applied when a rule using this action matches. log and skip_log continue evaluation; skip_log leaves the request out of the logs unless another rule acts on it or the response status is 400 or higher.

Enum values:

allow

block

challenge

rate_limit

log

skip_log

status_code

integer | null · min: 100 · max: 599

HTTP status returned by results that produce a response.

message

string | null · maxLength: 255

Response message returned by results that produce a response.

window_seconds

integer | null · min: 1 · max: 86400

Rate-limit window in seconds. Required when result is rate_limit.

requests_per_window

integer | null · min: 1

Requests allowed during the rate-limit window. Required when result is rate_limit.

partition_by

array | null · maxItems: 5 · unique

Dimensions that receive independent rate-limit buckets. An empty list creates one bucket per rule. Null leaves the scope to the proxy: per client IP on current proxies, a rule-derived bucket shared by all clients on older proxies.

Enum values:

client.ip

connection.id

request.fingerprint.ja4

request.url.domain

request.url.path

Create an action › Responses

The action was created.

Action · required

POST/actions

curl https://flowguard.network/api/v1/actions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Block synthetic scanners",
  "result": "allow",
  "status_code": 100,
  "message": "message",
  "window_seconds": 1,
  "requests_per_window": 1,
  "partition_by": [
    "client.ip"
  ]
}'

Example Request Body

{
  "name": "Block synthetic scanners",
  "result": "allow",
  "status_code": 100,
  "message": "message",
  "window_seconds": 1,
  "requests_per_window": 1,
  "partition_by": [
    "client.ip"
  ]
}

json

Example Responses

{
  "data": {
    "id": "action_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "name": "Block synthetic scanners",
    "result": "result",
    "status_code": 0,
    "message": "message",
    "window_seconds": 0,
    "requests_per_window": 0,
    "partition_by": [
      {}
    ],
    "rules_count": 0,
    "created_at": "created_at",
    "updated_at": "updated_at"
  }
}

json

application/json

Show an action

GET

https://flowguard.network/api/v1

/actions/{action}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Show one reusable action belonging to the authenticated team, including its result configuration and the number of rules using it.

Show an action › path Parameters

action

string · required

Show an action › Responses

Action

Action · required

Update an action

PATCH

https://flowguard.network/api/v1

/actions/{action}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Update an action belonging to the authenticated team. Omitted fields retain their current values. Changing the result replaces result-specific configuration with the supplied values and defaults for the new result.

Update an action › path Parameters

action

string · required

Update an action › Request Body

SaveActionRequest

name

string · maxLength: 255 · required

Human-readable action name.

Example: Block synthetic scanners

result

string · enum · required

Enum values:

allow

block

challenge

rate_limit

log

skip_log

status_code

integer | null · min: 100 · max: 599

HTTP status returned by results that produce a response.

message

string | null · maxLength: 255

Response message returned by results that produce a response.

window_seconds

integer | null · min: 1 · max: 86400

Rate-limit window in seconds. Required when result is rate_limit.

requests_per_window

integer | null · min: 1

Requests allowed during the rate-limit window. Required when result is rate_limit.

partition_by

array | null · maxItems: 5 · unique

Enum values:

client.ip

connection.id

request.fingerprint.ja4

request.url.domain

request.url.path

Update an action › Responses

Action

Action · required

PATCH/actions/{action}

curl https://flowguard.network/api/v1/actions/:action \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Block synthetic scanners",
  "result": "allow",
  "status_code": 100,
  "message": "message",
  "window_seconds": 1,
  "requests_per_window": 1,
  "partition_by": [
    "client.ip"
  ]
}'

Example Request Body

{
  "name": "Block synthetic scanners",
  "result": "allow",
  "status_code": 100,
  "message": "message",
  "window_seconds": 1,
  "requests_per_window": 1,
  "partition_by": [
    "client.ip"
  ]
}

json

Example Responses

{
  "data": {
    "id": "action_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "name": "Block synthetic scanners",
    "result": "result",
    "status_code": 0,
    "message": "message",
    "window_seconds": 0,
    "requests_per_window": 0,
    "partition_by": [
      {}
    ],
    "rules_count": 0,
    "created_at": "created_at",
    "updated_at": "updated_at"
  }
}

json

application/json

Delete an action

DELETE

https://flowguard.network/api/v1

/actions/{action}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Delete an action belonging to the authenticated team. Rules using the action remain in place but revert to doing nothing.

Delete an action › path Parameters

action

string · required

Delete an action › Responses

The action was deleted and detached from its rules.

string

Rules Servers