Cloudflare Node.js Bindings

To use the Cloudflare SDK, instantiate the Cloudflare class by passing an authentication object. The client supports both API Keys and API Tokens.

Authentication Options

When constructing the client, provide an auth object containing one of the following:

• email: Your Cloudflare account email address (required when using key).
• key: Your Cloudflare API key (used with email).
• token: Your Cloudflare API token (preferred for scoped access).

Proxy Configuration

The client automatically detects and configures an HTTPS proxy if the following environment variables are set:

• HTTPS_PROXY or https_proxy
• NO_PROXY or no_proxy (to exclude specific hosts)

If a proxy is configured, the client will use it to reach https://api.cloudflare.com.

const Cloudflare = require('cloudflare');

// Using an API Token (Recommended)
const client = new Cloudflare({
  token: 'YOUR_API_TOKEN'
});

// Using an API Key
const clientWithKey = new Cloudflare({
  email: 'user@example.com',
  key: 'YOUR_API_KEY'
});

The EnterpriseZoneWorkersKV resource provides an interface for interacting with Cloudflare Workers KV namespaces within an Enterprise Zone. It allows for basic CRUD operations on keys, including single and bulk operations.

Note: All methods require an account_id and a namespace_id as part of the resource path.

// Example usage of EnterpriseZoneWorkersKV methods

// List all keys in a namespace
await enterpriseZoneWorkersKV.browse(accountId, namespaceId);

// Add a single key-value pair
await enterpriseZoneWorkersKV.add(accountId, namespaceId, 'my-key', 'my-value');

// Read a value by key
const value = await enterpriseZoneWorkersKV.read(accountId, namespaceId, 'my-key');

// Delete a single key
await enterpriseZoneWorkersKV.del(accountId, namespaceId, 'my-key');

// Bulk add multiple key-value pairs
await enterpriseZoneWorkersKV.addMulti(accountId, namespaceId, [{ key: 'k1', value: 'v1' }, { key: 'k2', value: 'v2' }]);

// Bulk delete multiple keys
await enterpriseZoneWorkersKV.delMulti(accountId, namespaceId, ['k1', 'k2']);

The UserTokens resource provides an interface for managing Cloudflare User Tokens via the /user/tokens API endpoint. It allows you to list, create, retrieve, update, and delete tokens, as well as perform security operations like rolling or verifying secrets.

Available methods include:

• browse(): List user tokens.
• read(id): Retrieve details for a specific user token by its id.
• add(token): Create a new user token using a token configuration object.
• del(id): Delete a user token by its id.
• roll(id): Rotate the secret for a specific user token by its id.
• verify(): Verify the current token secret.
• browsePermissionGroups(): List all available permission groups for token creation.

// Example usage (assuming a client instance is initialized)

// List all tokens
const tokens = await userTokens.browse();

// Create a new token
const newToken = await userTokens.add({ /* token configuration */ });

// Roll a token's secret
const rolledToken = await userTokens.roll('TOKEN_ID');

// Verify the token secret
const verification = await userTokens.verify();

// Browse available permission groups
const groups = await userTokens.browsePermissionGroups();

The ZoneWorkersRoutes resource allows you to manage Workers routes for a specific Cloudflare zone. You can list, retrieve, create, update, or delete routes that trigger Workers based on specific patterns (like hostnames or paths) within a zone.

Base path: zones/:zoneId/workers/routes

// Note: This is a conceptual usage based on the resource definition
// Actual instantiation depends on your client setup

// List all routes in a zone
const routes = await zoneWorkersRoutes.browse(zone_id);

// Create a new route
const newRoute = await zoneWorkersRoutes.add(zone_id, { pattern: 'example.com/*', zone_id: zone_id });

// Update an existing route
const updatedRoute = await zoneWorkersRoutes.edit(zone_id, route_id, { pattern: 'new-pattern.com/*' });

// Get a specific route
const route = await zoneWorkersRoutes.read(zone_id, route_id);

// Delete a route
await zoneWorkersRoutes.del(zone_id, route_id);