Rulesets

Rules

Rules endpoint reference.

Create

Adds a new rule to a ruleset.

Param	Type	Required	Description
`accountId`	`string\|null`	Yes	Account Identifier. Provide exactly one of $accountId or $zoneId.
`zoneId`	`string\|null`	Yes	Zone Identifier. Provide exactly one of $accountId or $zoneId.
`rulesetId`	`string`	Yes	Ruleset Identifier.
`values`	`Rule\|array`	Yes	A rule object.

php

$response = $client->rulesets()->rules()->create('ACCOUNT_ID', 'ZONE_ID', 'RULESET_ID', $values);

View this operation on the Cloudflare API Reference

Edit

Updates an existing rule in a ruleset, creating a new version of the ruleset.

Param	Type	Required	Description
`accountId`	`string\|null`	Yes	Account Identifier. Provide exactly one of $accountId or $zoneId.
`zoneId`	`string\|null`	Yes	Zone Identifier. Provide exactly one of $accountId or $zoneId.
`rulesetId`	`string`	Yes	Ruleset Identifier.
`ruleId`	`string`	Yes	Rule Identifier.
`values`	`Rule\|array`	Yes	A rule object.

php

$response = $client->rulesets()->rules()->edit('ACCOUNT_ID', 'ZONE_ID', 'RULESET_ID', 'RULE_ID', $values);

View this operation on the Cloudflare API Reference

Delete

Deletes an existing rule from a ruleset, creating a new version of the ruleset.

Param	Type	Required	Description
`accountId`	`string\|null`	Yes	Account Identifier. Provide exactly one of $accountId or $zoneId.
`zoneId`	`string\|null`	Yes	Zone Identifier. Provide exactly one of $accountId or $zoneId.
`rulesetId`	`string`	Yes	Ruleset Identifier.
`ruleId`	`string`	Yes	Rule Identifier.

php

$response = $client->rulesets()->rules()->delete('ACCOUNT_ID', 'ZONE_ID', 'RULESET_ID', 'RULE_ID');

View this operation on the Cloudflare API Reference

Edit this pageorReport an issue

Rulesets

The Cloudflare Ruleset Engine allows you to create and deploy rules and rulesets in different Cloudflare products using the same basic syntax.

Versions

Every change to a ruleset creates a new version of it, and the old versions stay readable — useful for seeing what a ruleset looked like before a change, or for recovering a rule that was removed.