PHP Class CloudFlare\Zone

Zone A Zone is a domain name along with its subdomains and other identities

Author: James Bell ([email protected])

Inheritance: extends Api

Public Methods

Method	Description
activation_check ( string $identifier )	Initiate another zone activation check (permission needed: #zone:edit)
create ( string $name, boolean \| null $jump_start = null, integer \| null $organization = null )	Create a zone (permission needed: #zone:edit)
delete_zone ( string $zone_identifier )	Delete a zone (permission needed: #zone:edit)
edit_plan ( string $zone_identifier, object $plan )	Edit the desired plan for the zone (permission needed: #zone:edit)
edit_vanity_name_servers ( string $zone_identifier, array $vanity_name_servers )	Edit Vanity Name Servers (permission needed: #zone:edit)
pause ( string $zone_identifier )	Pause all CloudFlare features (permission needed: #zone:edit) This will pause all features and settings for the zone. DNS will still resolve
unpause ( string $zone_identifier )	Re-enable all CloudFlare features (permission needed: #zone:edit) This will restore all features and settings for the zone
zone ( string $zone_identifier )	Zone details (permission needed: #zone:read)
zones ( string \| null $name = null, string \| null $status = null, integer \| null $page = null, integer \| null $per_page = null, string \| null $order = null, string \| null $direction = null, string \| null $match = null )	List zones (permission needed: #zone:read) List, search, sort, and filter your zones

Initiate another zone activation check (permission needed: #zone:edit)

public activation_check ( string $identifier )
$identifier	string	API item identifier tag

Create a zone (permission needed: #zone:edit)

public create ( string $name, boolean \| null $jump_start = null, integer \| null $organization = null )
$name	string	The domain name
$jump_start	boolean \| null	Automatically attempt to fetch existing DNS records
$organization	integer \| null	To create a zone owned by an organization, specify the organization parameter. Organization objects can be found in the User or User's Organizations endpoints. You must pass at least the ID of the organization.

Delete a zone (permission needed: #zone:edit)

public delete_zone ( string $zone_identifier )
$zone_identifier	string	API item identifier tag

Edit the desired plan for the zone (permission needed: #zone:edit)

public edit_plan ( string $zone_identifier, object $plan )
$zone_identifier	string	API item identifier tag
$plan	object	The desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans

Edit Vanity Name Servers (permission needed: #zone:edit)

public edit_vanity_name_servers ( string $zone_identifier, array $vanity_name_servers )
$zone_identifier	string	API item identifier tag
$vanity_name_servers	array	An array of domains used for custom name servers. This is only available for Business and Enterprise plans.

Pause all CloudFlare features (permission needed: #zone:edit) This will pause all features and settings for the zone. DNS will still resolve

public pause ( string $zone_identifier )
$zone_identifier	string	API item identifier tag

Re-enable all CloudFlare features (permission needed: #zone:edit) This will restore all features and settings for the zone

public unpause ( string $zone_identifier )
$zone_identifier	string	API item identifier tag

Zone details (permission needed: #zone:read)

public zone ( string $zone_identifier )
$zone_identifier	string	API item identifier tag

List zones (permission needed: #zone:read) List, search, sort, and filter your zones

public zones ( string \| null $name = null, string \| null $status = null, integer \| null $page = null, integer \| null $per_page = null, string \| null $order = null, string \| null $direction = null, string \| null $match = null )
$name	string \| null	A domain name
$status	string \| null	Status of the zone (active, pending, initializing, moved, deleted)
$page	integer \| null	Page number of paginated results
$per_page	integer \| null	Number of zones per page
$order	string \| null	Field to order zones by (name, status, email)
$direction	string \| null	Direction to order zones (asc, desc)
$match	string \| null	Whether to match all search requirements or at least one (any) (any, all)