Set filtering rules

Creates or updates filtering rules for an environment in bulk. This action will overwrite any existing filtering rules on specified environment. If there is no filtering rules for an environment, this action creates them. To completely remove filtering rules, set both allow and deny lists to an empty array ([]). Currently only supports origin domain filtering.

Note: It can take up to 5 minutes to start filtering incoming requests after setting a rule.

POST /filtering-rules

Set filtering rules

cURL

curl --request POST \
  --url https://management-api.fpjs.io/filtering-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '
{
  "environment": "<string>",
  "allow": [
    "<string>"
  ],
  "deny": [
    "<string>"
  ]
}
'

201

{
  "data": [
    {
      "type": "origin",
      "environment": "ae_rrETjdWcfqI6AFsk",
      "allow": [
        "example.com",
        "my-website.com"
      ],
      "deny": [
        "*"
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version · string · required

Management API version.

Body

application/json

environment · string · required

Environment for which to set filtering rule.

allow · string[] · required

List of origin domains that are allowed to make requests, making all other domains denied by default. When setting the allow list, you must explicitly set the deny list to wildcard value (['*']).

deny · string[] · required

List of origin domains that are denied to make requests, making all other domains allowed by default. When setting the deny list, you must explicitly set the allow list to wildcard value (['*']).

Response

201

application/json

data · object[] · required

Show child attributes