PHP Class Cloudflare\Zone\Dns

DNS Record CloudFlare DNS records

Author: James Bell ([email protected])

Inheritance: extends CloudFlare\Api

Show file Open project: jamesryanbell/cloudflare Class Usage Examples

Public Methods

Method	Description
create ( string $zone_identifier, string $type, string $name, string $content, integer \| null $ttl = null, boolean \| null $proxied = null, integer \| null $priority = null, array \| null $data = null )	Create DNS record (permission needed: #dns_records:edit) Create a new DNS record for a zone. See the record object definitions for required attributes for each record type
delete_record ( string $zone_identifier, string $identifier )	Update DNS record (permission needed: #dns_records:edit)
details ( string $zone_identifier, string $identifier )	DNS record details (permission needed: #dns_records:read)
list_records ( string $zone_identifier, string \| null $type = null, string \| null $name = null, string \| null $content = null, string \| null $vanity_name_server_record = null, integer \| null $page = null, integer \| null $per_page = null, string \| null $order = null, string \| null $direction = null, string \| null $match = null )	List DNS Records (permission needed: #dns_records:read) List, search, sort, and filter a zones' DNS records.
update ( string $zone_identifier, string $identifier, string \| null $type = null, string \| null $name = null, string \| null $content = null, string \| null $ttl = null, boolean \| null $proxied = null, array \| null $data = null, integer \| null $priority = null )	Update DNS record (permission needed: #dns_records:edit)

Method Details

create() public method

Create DNS record (permission needed: #dns_records:edit) Create a new DNS record for a zone. See the record object definitions for required attributes for each record type

public create ( string $zone_identifier, string $type, string $name, string $content, integer \| null $ttl = null, boolean \| null $proxied = null, integer \| null $priority = null, array \| null $data = null )
$zone_identifier	string
$type	string	DNS record type (A, AAAA, CNAME, TXT, SRV, LOC, MX, NS, SPF)
$name	string	DNS record name
$content	string	DNS record content
$ttl	integer \| null	Time to live for DNS record. Value of 1 is 'automatic'
$proxied	boolean \| null	Whether to proxy the domain through CloudFlare or not
$priority	integer \| null	MX record priority value
$data	array \| null	Additional data required for SRV record

delete_record() public method

Update DNS record (permission needed: #dns_records:edit)

public delete_record ( string $zone_identifier, string $identifier )
$zone_identifier	string
$identifier	string	API item identifier tag

details() public method

DNS record details (permission needed: #dns_records:read)

public details ( string $zone_identifier, string $identifier )
$zone_identifier	string
$identifier	string	API item identifier tag

list_records() public method

List DNS Records (permission needed: #dns_records:read) List, search, sort, and filter a zones' DNS records.

public list_records ( string $zone_identifier, string \| null $type = null, string \| null $name = null, string \| null $content = null, string \| null $vanity_name_server_record = null, integer \| null $page = null, integer \| null $per_page = null, string \| null $order = null, string \| null $direction = null, string \| null $match = null )
$zone_identifier	string
$type	string \| null	DNS record type (A, AAAA, CNAME, TXT, SRV, LOC, MX, NS, SPF)
$name	string \| null	DNS record name
$content	string \| null	DNS record content
$vanity_name_server_record	string \| null	Flag for records that were created for the vanity name server feature (true, false)
$page	integer \| null	Page number of paginated results
$per_page	integer \| null	Number of DNS records per page
$order	string \| null	Field to order records by (type, name, content, ttl, proxied)
$direction	string \| null	Direction to order domains (asc, desc)
$match	string \| null	Whether to match all search requirements or at least one (any) (any, all)

update() public method

Update DNS record (permission needed: #dns_records:edit)

public update ( string $zone_identifier, string $identifier, string \| null $type = null, string \| null $name = null, string \| null $content = null, string \| null $ttl = null, boolean \| null $proxied = null, array \| null $data = null, integer \| null $priority = null )
$zone_identifier	string
$identifier	string	API item identifier tag
$type	string \| null	DNS record type (A, AAAA, CNAME, TXT, SRV, LOC, MX, NS, SPF)
$name	string \| null	DNS record name
$content	string \| null	DNS record content
$ttl	string \| null	Time to live for DNS record. Value of 1 is 'automatic'
$proxied	boolean \| null	Whether to proxy the domain through CloudFlare or not
$data	array \| null	Additional data required for SRV record
$priority	integer \| null	MX record priority value