PATCH /accounts/{account_id}/firewall/access_rules/rules/{rule_id}

Updates an IP Access rule defined at the account level.

Note: This operation will affect all zones in the account.

Servers

Path parameters

Name Type Required Description
account_id String Yes
rule_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String Yes

The unique identifier of the IP Access rule.

notes String No

An informative summary of the rule, typically used as a reminder or explanation.

configuration Object Yes

The rule configuration.

created_on String No

The timestamp of when the rule was created.

scope Object Yes

All zones owned by the user will have the rule applied.

scope.id String No

Defines an identifier.

scope.email String No

The contact email address of the user.

scope.type String No

Defines the scope of the rule.

Possible values:

  • "organization"
  • "user"
mode String Yes

The action to apply to a matched request.

Possible values:

  • "managed_challenge"
  • "block"
  • "challenge"
  • "js_challenge"
  • "whitelist"
allowed_modes[] Array Yes

The available actions that a rule can apply to a matched request.

modified_on String No

The timestamp of when the rule was last modified.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.