Class Zone

CloudFlare API wrapper

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

Cloudflare\Api

Extended by

Cloudflare\Zone

Namespace: Cloudflare
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/Zone.php

Methods summary
`public`	# `create( string $name, boolean\|null $jump_start = null, integer\|null $organization = null )` Create a zone (permission needed: #zone:edit) Create a zone (permission needed: #zone:edit) Parameters `$name` $domain The domain name `$jump_start` Automatically attempt to fetch existing DNS records `$organization` 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.
`public`	# `activation_check( string $identifier )` Initiate another zone activation check (permission needed: #zone:edit) Initiate another zone activation check (permission needed: #zone:edit) Parameters `$identifier` API item identifier tag
`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 )` List zones (permission needed: #zone:read) List, search, sort, and filter your zones List zones (permission needed: #zone:read) List, search, sort, and filter your zones Parameters `$name` A domain name `$status` Status of the zone (active, pending, initializing, moved, deleted) `$page` Page number of paginated results `$per_page` Number of zones per page `$order` Field to order zones by (name, status, email) `$direction` Direction to order zones (asc, desc) `$match` Whether to match all search requirements or at least one (any) (any, all)
`public`	# `zone( string $zone_identifier )` Zone details (permission needed: #zone:read) Zone details (permission needed: #zone:read) Parameters `$zone_identifier` API item identifier tag
`public`	# `edit_vanity_name_servers( string $zone_identifier, array $vanity_name_servers )` Edit Vanity Name Servers (permission needed: #zone:edit) Edit Vanity Name Servers (permission needed: #zone:edit) Parameters `$zone_identifier` API item identifier tag `$vanity_name_servers` An array of domains used for custom name servers. This is only available for Business and Enterprise plans.
`public`	# `edit_plan( string $zone_identifier, object $plan )` Edit the desired plan for the zone (permission needed: #zone:edit) Edit the desired plan for the zone (permission needed: #zone:edit) Parameters `$zone_identifier` API item identifier tag `$plan` The desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans
`public`	# `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 Pause all CloudFlare features (permission needed: #zone:edit) This will pause all features and settings for the zone. DNS will still resolve Parameters `$zone_identifier` API item identifier tag
`public`	# `unpause( string $zone_identifier )` Re-enable all CloudFlare features (permission needed: #zone:edit) This will restore all features and settings for the zone Re-enable all CloudFlare features (permission needed: #zone:edit) This will restore all features and settings for the zone Parameters `$zone_identifier` API item identifier tag
`public`	# `delete_zone( string $zone_identifier )` Delete a zone (permission needed: #zone:edit) Delete a zone (permission needed: #zone:edit) Parameters `$zone_identifier` API item identifier tag

Methods inherited from Cloudflare\Api
`__construct(), delete(), get(), patch(), permissions(), post(), put(), request(), setAuthKey(), setCurlOption(), setEmail()`

Properties summary
`protected array`	`$permission_level` Default permissions level Default permissions level	# `['read' => '#zone:read', 'edit' => '#zone:edit']`

Properties inherited from Cloudflare\Api
`$auth_key, $curl_options, $email`