Overview

Namespaces

  • Cloudflare
    • Organizations
      • Firewall
        • AccessRules
    • User
      • Billing
        • Subscriptions
      • Firewall
    • Zone
      • Firewall
      • SSL
      • WAF
        • Packages

Classes

  • Invites
  • Members
  • Organizations
  • Railguns
  • Roles
  • Virtual_Dns
  • Overview
  • Namespace
  • Class

Class Virtual_Dns

CloudFlare API wrapper

Virtual DNS (Organizations) Organizations-level Virtual DNS Management

Cloudflare\Api
Extended by Cloudflare\Organizations\Virtual_Dns
Namespace: Cloudflare\Organizations
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/Organizations/VirtualDns.php
Methods summary
public
# clusters( string $organization_identifier )

Get Virtual DNS Clusters (permission needed: #dns_records:read) List configured Virtual DNS clusters for an organization

Get Virtual DNS Clusters (permission needed: #dns_records:read) List configured Virtual DNS clusters for an organization

Parameters

$organization_identifier
organization_identifier tag
public
# create( string $organization_identifier, string $name, array $origin_ips, integer|null $minimum_cache_ttl = null, integer|null $maximum_cache_ttl = null, boolean|null $deprecate_any_request = null )

Create a Virtual DNS Cluster (permission needed: #dns_records:edit) Create a configured Virtual DNS Cluster

Create a Virtual DNS Cluster (permission needed: #dns_records:edit) Create a configured Virtual DNS Cluster

Parameters

$organization_identifier
organization_identifier tag
$name
Virtual DNS Cluster Name
$origin_ips
$minimum_cache_ttl
Minimum DNS Cache TTL
$maximum_cache_ttl
Maximum DNS Cache TTL
$deprecate_any_request
Deprecate the response to ANY requests
public
# cluster( string $organization_identifier, string $identifier )

Get a Virtual DNS Cluster (permission needed: #dns_records:read) List a single configured Virtual DNS clusters for an organization

Get a Virtual DNS Cluster (permission needed: #dns_records:read) List a single configured Virtual DNS clusters for an organization

Parameters

$organization_identifier
organization_identifier tag
$identifier
identifier tag
public
# modify( string $organization_identifier, string $identifier, string $name, array $origin_ips, integer $minimum_cache_ttl, integer $maximum_cache_ttl, boolean $deprecate_any_request )

Modify a Virtual DNS Cluster Modify a Virtual DNS Cluster configuration (permission needed: #dns_records:edit)

Modify a Virtual DNS Cluster Modify a Virtual DNS Cluster configuration (permission needed: #dns_records:edit)

Parameters

$organization_identifier
organization_identifier tag
$identifier
identifier tag
$name
Virtual DNS Cluster Name
$origin_ips
$minimum_cache_ttl
Minimum DNS Cache TTL
$maximum_cache_ttl
Maximum DNS Cache TTL
$deprecate_any_request
Deprecate the response to ANY requests
public
# delete_cluster( string $organization_identifier, string $identifier )

Delete a Virtual DNS Cluster (permission needed: #dns_records:edit) Delete a configured Virtual DNS cluster

Delete a Virtual DNS Cluster (permission needed: #dns_records:edit) Delete a configured Virtual DNS cluster

Parameters

$organization_identifier
organization_identifier tag
$identifier
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' => '#dns_records:read', 'edit' => '#dns_records:edit']
Properties inherited from Cloudflare\Api
$auth_key, $curl_options, $email
API documentation generated by ApiGen