Mutate filtering rules

Allows atomic mutation to filtering rules for an environment. Explicitly specify which list (allow or deny) you are mutating and which operation (add or remove) you want to execute with the given list of items. Currently only supports origin domain filtering.

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

PATCH /filtering-rules

Mutate filtering rules

cURL

curl --request PATCH \
  --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>",
  "items": [
    "<string>"
  ]
}
'

200

{
  "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

ID of an environment for which we are mutating the filtering rules.

permission · enum<string> · required

Permission list we want to mutate, either allow or deny.

Available options: allow, deny

op · enum<string> · required

Operation we are executing on specified permission list, either add or remove.

Available options: add, remove

items · string[] · required

List of items we are mutating with the given operation on the given permission list.

Response

200

application/json

data · object[] · required

Show child attributes