Create a cache rule via API

Use the Rulesets API to create a cache rule via API. To configure Cloudflare’s API refer to the API documentation.

​​ Basic rule settings

When creating a cache rule via API, make sure you:

• Set the rule action to set_cache_settings.
• Define the parameters in the action_parameters field according to the settings you wish to override for matching requests.
• Deploy the rule to the http_request_cache_settings phase entry point ruleset.

​​ Procedure

1. Use the List zone rulesets Open API docs link method to obtain the list of rules already present in the http_request_cache_settings phase entry point ruleset.
2. If the phase ruleset does not exist, create it using the Create a zone ruleset Open API docs link operation. In the new ruleset properties, set the following values:
   • kind: zone
   • phase: http_request_cache_settings
3. Use the Update a zone ruleset Open API docs link operation to add a cache rule to the list of ruleset rules. Alternatively, include the rule in the Create a zone ruleset Open API docs link request mentioned in the previous step.
4. (Optional) To update an existing cache rule, use the Update a zone ruleset rule Open API docs link operation. For an example, refer to the section below.

​​ Example requests

These examples are setting all the Cache Rules of a zone to a single rule, since using these examples directly will cause any existing rules to be deleted.

​​ Required API token permissions

The API token used in API requests to manage Cache Rules must have the following permissions:

• Zone > Cache Rules > Edit
• Account Rulesets > Edit
• Account Filter Lists > Edit