PHP Class Cloudflare\Zone\Railgun

Railguns for a Zone
Author: James Bell ([email protected])
Inheritance: extends CloudFlare\Api
Show file Open project: jamesryanbell/cloudflare

Public Methods

Method Description
connected ( string $zone_identifier, string $identifier, boolean $connected ) Connect or disconnect a Railgun (permission needed: #zone_settings:edit) Connect or disconnect a Railgun
details ( string $zone_identifier, string $identifier ) Get Railgun details (permission needed: #zone_settings:read) Details about a specific Railgun
diagnose ( string $zone_identifier, string $identifier ) Test Railgun connection (permission needed: #zone_settings:read) Test Railgun connection to the Zone
railguns ( string $zone_identifier ) Get available Railguns (permission needed: #zone_settings:read) A list of available Railguns the zone can use

Method Details

connected() public method

Connect or disconnect a Railgun (permission needed: #zone_settings:edit) Connect or disconnect a Railgun
public connected ( string $zone_identifier, string $identifier, boolean $connected )
$zone_identifier string
$identifier string API item identifier tag
$connected boolean A flag indicating whether the given zone is connected to the Railgun [valid values: (true,false)]

details() public method

Get Railgun details (permission needed: #zone_settings:read) Details about a specific Railgun
public details ( string $zone_identifier, string $identifier )
$zone_identifier string API item identifier tag
$identifier string

diagnose() public method

Test Railgun connection (permission needed: #zone_settings:read) Test Railgun connection to the Zone
public diagnose ( string $zone_identifier, string $identifier )
$zone_identifier string API item identifier tag
$identifier string

railguns() public method

Get available Railguns (permission needed: #zone_settings:read) A list of available Railguns the zone can use
public railguns ( string $zone_identifier )
$zone_identifier string API item identifier tag