Overview

Namespaces

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

Classes

  • Analytics
  • Cache
  • CustomPages
  • CustomSSL
  • Dns
  • KeylessSSL
  • Pagerules
  • Plan
  • Railgun
  • Settings
  • SSL
  • Overview
  • Namespace
  • Class

Class Railgun

CloudFlare API wrapper

Railguns for a Zone

Cloudflare\Api
Extended by Cloudflare\Zone\Railgun
Namespace: Cloudflare\Zone
Author: James Bell james@james-bell.co.uk
Version: 1
Located at CloudFlare/Zone/Railgun.php
Methods summary
public
# railguns( string $zone_identifier )

Get available Railguns (permission needed: #zone_settings:read) A list of available Railguns the zone can use

Get available Railguns (permission needed: #zone_settings:read) A list of available Railguns the zone can use

Parameters

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

Get Railgun details (permission needed: #zone_settings:read) Details about a specific Railgun

Get Railgun details (permission needed: #zone_settings:read) Details about a specific Railgun

Parameters

$zone_identifier
API item identifier tag
$identifier
public
# diagnose( string $zone_identifier, string $identifier )

Test Railgun connection (permission needed: #zone_settings:read) Test Railgun connection to the Zone

Test Railgun connection (permission needed: #zone_settings:read) Test Railgun connection to the Zone

Parameters

$zone_identifier
API item identifier tag
$identifier
public
# connected( string $zone_identifier, string $identifier, boolean $connected )

Connect or disconnect a Railgun (permission needed: #zone_settings:edit) Connect or disconnect a Railgun

Connect or disconnect a Railgun (permission needed: #zone_settings:edit) Connect or disconnect a Railgun

Parameters

$zone_identifier
$identifier
API item identifier tag
$connected
A flag indicating whether the given zone is connected to the Railgun [valid values: (true,false)]
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' => '#zone_settings:read', 'edit' => '#zone_settings:edit']
Properties inherited from Cloudflare\Api
$auth_key, $curl_options, $email
API documentation generated by ApiGen