PHP Class Cloudflare\User\LoadBalancers\Monitors

CTM Monitors Cloud Traffic Manager Monitor

Author: James Bell ([email protected])

Inheritance: extends CloudFlare\Api

Public Methods

Method	Description
create ( string $expected, string $type, string $expected_codes, string \| null $method = null, string \| null $path = null, integer \| null $interval = null, integer \| null $retries = null, array \| null $headers = null, integer \| null $probe_timeout = null, string \| null $description = null )	Create a monitor Create a configured monitor
delete_monitor ( string $identifier )	Delete a monitor Delete a configured monitor
details ( string $identifier )	Monitor details List a single configured CTM monitor for a user
monitors ( )	List monitors List configured monitors for a user
update ( string $identifier, string \| null $expected = null, string \| null $type = null, string \| null $expected_codes = null, string \| null $method = null, string \| null $path = null, integer \| null $interval = null, integer \| null $retries = null, array \| null $headers = null, integer \| null $probe_timeout = null, string \| null $description = null )	Modify a monitor Modify a configured monitor

Create a monitor Create a configured monitor

public create ( string $expected, string $type, string $expected_codes, string \| null $method = null, string \| null $path = null, integer \| null $interval = null, integer \| null $retries = null, array \| null $headers = null, integer \| null $probe_timeout = null, string \| null $description = null )
$expected	string	A case-insensitive substring to match in the body of the probe response to declare an origin as up
$type	string	Monitor type
$expected_codes	string	The expected HTTP response code or code range for the probe
$method	string \| null	The HTTP method for the probe
$path	string \| null	The endpoint path to probe
$interval	integer \| null	The interval in seconds for each PoP to send a probe request
$retries	integer \| null	The number of retries before declaring the origins to be dead
$headers	array \| null	The HTTP headers to use in the probe
$probe_timeout	integer \| null	Timeout in seconds for each probe request
$description	string \| null	Object description

Delete a monitor Delete a configured monitor

public delete_monitor ( string $identifier )
$identifier	string

Monitor details List a single configured CTM monitor for a user

public details ( string $identifier )
$identifier	string

List monitors List configured monitors for a user

public monitors ( )

Modify a monitor Modify a configured monitor

public update ( string $identifier, string \| null $expected = null, string \| null $type = null, string \| null $expected_codes = null, string \| null $method = null, string \| null $path = null, integer \| null $interval = null, integer \| null $retries = null, array \| null $headers = null, integer \| null $probe_timeout = null, string \| null $description = null )
$identifier	string
$expected	string \| null	A case-insensitive substring to match in the body of the probe response to declare an origin as up
$type	string \| null	Monitor type
$expected_codes	string \| null	The expected HTTP response code or code range for the probe
$method	string \| null	The HTTP method for the probe
$path	string \| null	The endpoint path to probe
$interval	integer \| null	The interval in seconds for each PoP to send a probe request
$retries	integer \| null	The number of retries before declaring the origins to be dead
$headers	array \| null	The HTTP headers to use in the probe
$probe_timeout	integer \| null	Timeout in seconds for each probe request
$description	string \| null	Object description