PHP Class Cloudflare\Zone\LoadBalancers

CTM Load Balancer User-level Cloud Traffic Manager Load Balancer
Author: James Bell ([email protected])
Inheritance: extends CloudFlare\Api
Show file Open project: jamesryanbell/cloudflare

Public Methods

Method Description
create ( string $zone_identifier, string $name, string $global_policy, string | null $description = null, integer | null $ttl = null, boolean | null $proxied = null ) Create a load balancer Create a new load balancer
delete_load_balancer ( string $zone_identifier, string $identifier ) Delete a load balancer Delete a configured load balancer
details ( string $identifier ) Load balancer details Fetch a single configured load balancer
load_balancers ( string $zone_identifier ) List load balancers List configured load balancers
update ( string $zone_identifier, string $identifier, string | null $name = null, string | null $global_policy = null, string | null $description = null, integer | null $ttl = null, boolean | null $proxied = null ) Modify a load balancer Modify a configured load balancer

Method Details

create() public method

Create a load balancer Create a new load balancer
public create ( string $zone_identifier, string $name, string $global_policy, string | null $description = null, integer | null $ttl = null, boolean | null $proxied = null )
$zone_identifier string
$name string A hostname of the record that should provide load balancing capabilities. If this name already exists as a DNS record in your CloudFlare DNS, the existing record will take precedence over the Load Balancer.
$global_policy string ID of the Global Policy object.
$description string | null Object description.
$ttl integer | null Time to live (TTL) of the DNS entry for the IP address returned by this load balancer.
$proxied boolean | null Whether the hostname should be grey clouded (False) or orange clouded (True).

delete_load_balancer() public method

Delete a load balancer Delete a configured load balancer
public delete_load_balancer ( string $zone_identifier, string $identifier )
$zone_identifier string
$identifier string

details() public method

Load balancer details Fetch a single configured load balancer
public details ( string $identifier )
$identifier string

load_balancers() public method

List load balancers List configured load balancers
public load_balancers ( string $zone_identifier )
$zone_identifier string

update() public method

Modify a load balancer Modify a configured load balancer
public update ( string $zone_identifier, string $identifier, string | null $name = null, string | null $global_policy = null, string | null $description = null, integer | null $ttl = null, boolean | null $proxied = null )
$zone_identifier string
$identifier string
$name string | null A hostname of the record that should provide load balancing capabilities. If this name already exists as a DNS record in your CloudFlare DNS, the existing record will take precedence over the Load Balancer.
$global_policy string | null ID of the Global Policy object.
$description string | null Object description.
$ttl integer | null Time to live (TTL) of the DNS entry for the IP address returned by this load balancer.
$proxied boolean | null Whether the hostname should be grey clouded (False) or orange clouded (True).