Client Reference

Rulesets

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

List

Fetches all rulesets.

Param	Type	Required	Default	Description
`accountId`	`string\|null`	No		Account Identifier. Provide exactly one of $accountId or $zoneId.
`zoneId`	`string\|null`	No		Zone Identifier. Provide exactly one of $accountId or $zoneId.

php

$response = $client->rulesets()->list('ACCOUNT_ID', 'ZONE_ID');

View this operation on the Cloudflare API Reference

Creates 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.
`values`	`mixed`	Yes	A ruleset object.

php

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

View this operation on the Cloudflare API Reference

Fetches the latest version of 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.

php

$response = $client->rulesets()->get('ACCOUNT_ID', 'ZONE_ID', 'RULESET_ID');

View this operation on the Cloudflare API Reference

Deletes all versions of an existing 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.

php

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

View this operation on the Cloudflare API Reference

Previews

Previews endpoint reference.

Rules

Rules endpoint reference.