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 Railguns

CloudFlare API wrapper

Organization Railgun CloudFlare Railgun for Organizations

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

Create Railgun (permission needed: #organization:edit)

Create Railgun (permission needed: #organization:edit)

Parameters

$organization_identifier
Organization identifier tag
$name
Readable identifier of the railgun
public
# railguns( string $organization_identifier, integer|null $page = null, integer|null $per_page = null, string|null $direction = null )

List Railguns (permission needed: #organization:read) List, search, sort and filter your Railguns

List Railguns (permission needed: #organization:read) List, search, sort and filter your Railguns

Parameters

$organization_identifier
Organization identifier tag
$page
Page number of paginated results
$per_page
Number of items per page
$direction
Direction to order Railguns (asc, desc)
public
# details( string $organization_identifier, string $identifier )

Railgun details (permission needed: #organization:read)

Railgun details (permission needed: #organization:read)

Parameters

$organization_identifier
Organization identifier tag
$identifier
API item identifier tag
public
# zones( string $organization_identifier, string $identifier )

Get zones connected to a Railgun (permission needed: #organization:read) The zones that are currently using this Railgun

Get zones connected to a Railgun (permission needed: #organization:read) The zones that are currently using this Railgun

Parameters

$organization_identifier
Organization identifier tag
$identifier
API item identifier tag
public
# enabled( string $organization_identifier, string $zone_identifier, boolean|null $enabled = null )

Enable or disable a Railgun (permission needed: #organization:edit) Enable or disable a Railgun for all zones connected to it

Enable or disable a Railgun (permission needed: #organization:edit) Enable or disable a Railgun for all zones connected to it

Parameters

$organization_identifier
Organization identifier tag
$zone_identifier
API item identifier tag
$enabled
Flag to determine if the Railgun is accepting connections
public
# delete_railgun( string $organization_identifier, string $identifier )

Delete Railgun (permission needed: #organization:edit) Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones

Delete Railgun (permission needed: #organization:edit) Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones

Parameters

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