Client Reference
Zones
Zones endpoint reference.
List
Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. | |
params | array | No | [] | Query Parameters. |
php
$response = $client->zones()->list('ACCOUNT_ID', []);
Create
Create Zone
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. | |
values | array | Yes | `name`, the domain name, is required. `type` is `full` when Cloudflare hosts the DNS, or `partial` for a partner-hosted or CNAME setup. |
php
$response = $client->zones()->create('ACCOUNT_ID', []);
Get
Zone Details
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. |
php
$response = $client->zones()->get('ZONE_ID');
Delete
Delete Zone
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. |
php
$response = $client->zones()->delete('ZONE_ID');
Edit
Edit Zone
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
values | array | Yes | Any of `type` (`full` or `partial`, Enterprise-only unless enabled on the zone), `vanity_name_servers` (Business and Enterprise plans), `paused` and `plan`. |
php
$response = $client->zones()->edit('ZONE_ID', []);
Activation Check
Triggeres a new activation check for a PENDING Zone. This can be triggered every 5 min for paygo/ent customers, every hour for FREE Zones.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. |
php
$response = $client->zones()->activationCheck('ZONE_ID');
Purge
Purge Cached Content
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
zoneId | string | Yes | Zone Identifier. | |
purgeBy | CachePurge|array | Yes |
php
$response = $client->zones()->purge('ZONE_ID', $purgeBy);