README

Installation

The recommended way to install this package is via the Packagist Dependency Manager (cloudflare/sdk). You can specific usage examples on the Cloudflare Knowledge Base under: Cloudflare PHP API Binding

Cloudflare API version 4

The Cloudflare API can be found here. Each API call is provided via a similarly named function within various classes in the Cloudflare\API\Endpoints namespace:

DNS Records
Zones
User Administration (partial)
Cloudflare IPs
Page Rules
Web Application Firewall (WAF)
Virtual DNS Management
Custom hostnames
Manage TLS settings
Zone Lockdown and User-Agent Block rules
Organization Administration
Railgun administration
Keyless SSL
Origin CA

Note that this repository is currently under development, additional classes and endpoints being actively added.

Getting Started

$key     = new Cloudflare\API\Auth\APIKey('user@example.com', 'apiKey');
$adapter = new Cloudflare\API\Adapter\Guzzle($key);
$user    = new Cloudflare\API\Endpoints\User($adapter);
    
echo $user->getUserID();

Contributions

We welcome community contribution to this repository. CONTRIBUTING.md will help you start contributing.

Licensing

Licensed under the 3-clause BSD license. See the LICENSE file for details.

affcool / cloudflare

Maintainers

Details