Module reference

The examples above are a starting point. For the actual method names, arguments, and return conventions, follow the Markdown reference kept beside each module's Perl source. Those sidecars are the maintained method reference; this article stays focused on how the pieces fit together. Cloudflare defines the fields inside many request bodies and returned result values, so consult the relevant Cloudflare endpoint when you need its complete schema.

Cloudflare::API

Constructor options, environment defaults, resource accessors, low-level requests, and response handling.

Cloudflare::API::Accounts

List accounts or retrieve one by ID.

Cloudflare::API::Zones

List zones or retrieve one by ID.

Cloudflare::API::Workers

Scripts, staged versions, deployments, assets, secrets, subdomains, and routes. Start here for upload arguments and return values.

Cloudflare::API::R2

Bucket management through the REST API.

Cloudflare::API::KV

Namespace management, key lists, and raw value reads and writes.

Cloudflare::API::D1

Database management and REST queries with separate SQL parameters.

Cloudflare::API::Queues

Queue and consumer management.

Cloudflare::API::Hyperdrive

Connection configuration management, including the distinction between configuration and SQL access.

Cloudflare::API::SecretsStore

Stores, secret metadata, write-only values, and quota information.

Cloudflare::API::Error

The exception raised when a decoded Cloudflare response reports failure despite an HTTP success response.

For the script's full option reference, run cloudflare-api --man. The --help form is shorter when you only need to recall an option name.