PHP Class CloudFlare\Railguns

Railguns CloudFlare Railgun
Author: James Bell ([email protected])
Inheritance: extends Api
Mostrar archivo Open project: jamesryanbell/cloudflare

Public Methods

Method Description
create ( string $name ) Create Railgun (permission needed: #railgun:edit)
delete_railgun ( string $identifier ) Delete Railgun (permission needed: #railgun:edit) Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones
details ( string $identifier ) Railgun details (permission needed: #railgun:read)
enabled ( string $identifier, boolean | null $enabled = null ) Enable or disable a Railgun (permission needed: #railgun:edit) Enable or disable a Railgun for all zones connected to it
railguns ( integer | null $page = null, integer | null $per_page = null, string | null $direction = null ) List Railguns (permission needed: #railgun:read) List, search, sort and filter your Railguns
zones ( string $identifier ) Get zones connected to a Railgun (permission needed: #railgun:read) The zones that are currently using this Railgun

Method Details

create() public method

Create Railgun (permission needed: #railgun:edit)
public create ( string $name )
$name string Readable identifier of the railgun

delete_railgun() public method

Delete Railgun (permission needed: #railgun:edit) Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones
public delete_railgun ( string $identifier )
$identifier string API item identifier tag

details() public method

Railgun details (permission needed: #railgun:read)
public details ( string $identifier )
$identifier string API item identifier tag

enabled() public method

Enable or disable a Railgun (permission needed: #railgun:edit) Enable or disable a Railgun for all zones connected to it
public enabled ( string $identifier, boolean | null $enabled = null )
$identifier string API item identifier tag
$enabled boolean | null Flag to determine if the Railgun is accepting connections

railguns() public method

List Railguns (permission needed: #railgun:read) List, search, sort and filter your Railguns
public railguns ( integer | null $page = null, integer | null $per_page = null, string | null $direction = null )
$page integer | null Page number of paginated results
$per_page integer | null Number of items per page
$direction string | null Direction to order Railguns (asc, desc)

zones() public method

Get zones connected to a Railgun (permission needed: #railgun:read) The zones that are currently using this Railgun
public zones ( string $identifier )
$identifier string API item identifier tag