cloudflare/sdk

PHP binding for v4 of the Cloudflare Client API.

1.4.0 2024-12-17 23:18 UTC

Requires

• php: >=7.2.5
• ext-json: *
• guzzlehttp/guzzle: ^7.0.1
• psr/http-message: ~1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.6
• phpmd/phpmd: @stable
• phpunit/phpunit: ^5.7

BSD-3-Clause

• Junade Ali

README

Installation

The recommended way to install this package is via the Packagist Dependency Manager (cloudflare/sdk). You can get 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
• DNS Analytics
• 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
• Crypto
• Load Balancers
• Firewall Settings

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

Getting Started

$key     = new Cloudflare\API\Auth\APIKey('[e-mail]', '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.