POST /zones/{zone_id}/firewall/ua_rules

Creates a new User Agent Blocking rule in a zone.

Servers

https://api.cloudflare.com/client/v4

Path parameters

Name	Type	Required	Description
`zone_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
`description`	String	No	An informative summary of the rule. This value is sanitized and any tags will be removed.
`configuration`	Object	Yes
`configuration.target`	String	No	The configuration target. You must set the target to `ua` when specifying a user agent in the rule. Possible values: `"ua"`
`configuration.value`	String	No	the user agent to exactly match
`mode`	String	Yes	The action to apply to a matched request. Possible values: `"managed_challenge"` `"block"` `"challenge"` `"js_challenge"` `"whitelist"`
`paused`	Boolean	No	When true, indicates that the rule is currently paused.

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.