PHP Class Cloudflare\Organizations\Railguns

Organization Railgun CloudFlare Railgun for Organizations

Author: James Bell ([email protected])

Inheritance: extends CloudFlare\Api

Show file Open project: jamesryanbell/cloudflare

Public Methods

Method	Description
create ( string $organization_identifier, string $name )	Create Railgun (permission needed: #organization:edit)
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
details ( string $organization_identifier, string $identifier )	Railgun details (permission needed: #organization:read)
enabled ( string $organization_identifier, string $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
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
zones ( string $organization_identifier, string $identifier )	Get zones connected to a Railgun (permission needed: #organization:read) The zones that are currently using this Railgun

Method Details

create() public method

Create Railgun (permission needed: #organization:edit)

public create ( string $organization_identifier, string $name )
$organization_identifier	string	Organization identifier tag
$name	string	Readable identifier of the railgun

delete_railgun() public method

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

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

details() public method

Railgun details (permission needed: #organization:read)

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

enabled() public method

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

public enabled ( string $organization_identifier, string $identifier, boolean \| null $enabled = null )
$organization_identifier	string	Organization identifier tag
$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: #organization:read) List, search, sort and filter your Railguns

public railguns ( string $organization_identifier, integer \| null $page = null, integer \| null $per_page = null, string \| null $direction = null )
$organization_identifier	string	Organization identifier tag
$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: #organization:read) The zones that are currently using this Railgun

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