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.
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. | |
params | array | No | [] | Query Parameters: `cursor` and `per_page`. |
php
$response = $client->rulesets()->list('ACCOUNT_ID', 'ZONE_ID', []);
Create
Creates a ruleset.
| Param | Type | Required | Default | 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 | Ruleset|array | Yes | A ruleset object. |
php
$response = $client->rulesets()->create('ACCOUNT_ID', 'ZONE_ID', $values);
Get
Fetches the latest version of a ruleset.
| Param | Type | Required | Default | 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');
Update
Updates a ruleset, creating a new version of it.
The rules given replace the ones the ruleset holds, so send the full set, not just the ones that changed.
| Param | Type | Required | Default | 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 | Ruleset|array | Yes | A ruleset object. |
php
$response = $client->rulesets()->update('ACCOUNT_ID', 'ZONE_ID', 'RULESET_ID', $values);
Delete
Deletes all versions of an existing ruleset.
| Param | Type | Required | Default | 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');