Cloudflare.Storage 0.1.5

Cloudflare.Net

<p align="center"> <img src="logo.svg" alt="Cloudflare" width="300" /> </p>

English | 中文 | 日本語 | Français

A comprehensive .NET client library for the Cloudflare API, covering all 445+ resource categories including DNS, Zones, Workers, R2, KV, WAF, Zero Trust, and more.

Features

• ✅ Full API Coverage — 1,708 endpoints across 445+ Cloudflare resource categories
• ✅ Multi-targeting — Supports netstandard2.0, netstandard2.1, net8.0, net9.0, net10.0
• ✅ Strongly-typed — Auto-generated from the official OpenAPI specification
• ✅ 3 Auth Methods — API Token (Bearer), Global API Key (Email+Key), Origin CA Key
• ✅ Dependency Injection — First-class support for Microsoft.Extensions.DependencyInjection
• ✅ CancellationToken — Full async/await with cancellation support
• ✅ SourceLink — Debug into library source code
• ✅ Wrangler Integration — Read token directly from wrangler CLI config

Installation

dotnet add package Cloudflare.Net

Quick Start

Direct Usage

using Cloudflare.Net;

// Create client with your API token (recommended)
var client = CloudflareClientFactory.Create("your_api_token");

// Or use Global API Key
var client = CloudflareClientFactory.Create("email@example.com", "your_global_api_key");

// Or read token from environment variable CLOUDFLARE_API_TOKEN
var client = CloudflareClientFactory.CreateFromEnvironment();

// Or read token from wrangler config (~/.wrangler/config/default.toml)
var client = CloudflareClientFactory.CreateFromWranglerConfig();

// List all zones
var zones = await client.Zones.GetAsync();

// Manage DNS records
var records = await client.Zones["zone_id"].DnsRecords.GetAsync();

// List Workers scripts
var scripts = await client.Accounts["account_id"].Workers.Scripts.GetAsync();

With Dependency Injection

using Cloudflare.Net.Extensions;

// In Program.cs or Startup.cs
builder.Services.AddCloudflareClient(options =>
{
    options.Token = builder.Configuration["Cloudflare:Token"]!;
});

// Or use Global API Key
builder.Services.AddCloudflareClient(options =>
{
    options.Email = builder.Configuration["Cloudflare:Email"]!;
    options.ApiKey = builder.Configuration["Cloudflare:ApiKey"]!;
});

// In your service class
public class MyService(CloudflareApiClient client)
{
    public async Task ListZones()
    {
        var response = await client.Zones.GetAsync();
        // ...
    }
}

Advanced Configuration

// Custom options
var client = CloudflareClientFactory.Create(new CloudflareClientOptions
{
    Token = "your_api_token",
    BaseUrl = "https://api.cloudflare.com/client/v4",
    Timeout = TimeSpan.FromSeconds(60),
    UserAgent = "MyApp/1.0"
});

// Use your own HttpClient (for proxies, custom handlers, etc.)
var httpClient = new HttpClient(new MyCustomHandler());
var client = CloudflareClientFactory.Create("your_api_token", httpClient);

API Coverage

Authentication

Cloudflare supports three authentication methods:

1. API Token (Recommended)

Header: Authorization: Bearer <token>

Generate from Cloudflare Dashboard > API Tokens. Supports fine-grained permissions.

2. Global API Key

Headers: X-Auth-Email + X-Auth-Key

Found in Cloudflare Dashboard > API Keys. Full account access — use API Tokens instead when possible.

3. Origin CA Key

Header: X-Auth-User-Service-Key

Used exclusively for Origin CA certificate operations.

Technical Architecture

Code Generation

The client code is auto-generated by Microsoft Kiota from the Cloudflare official OpenAPI specification. This means:

• Completeness: 1,708 of 1,729 API paths covered (98.8%)
• Accuracy: Request/response models strictly match API definitions, ensuring type safety
• Maintainability: When Cloudflare updates their API, simply regenerate to sync

Dependencies Explained

Kiota Runtime (API Client Core)

Dependency Injection Support

Tool Support

Multi-Target Framework Compatibility

Requirements

• .NET Standard 2.0+ / .NET 8.0+ / .NET 9.0+ / .NET 10.0+
• A Cloudflare account and API token

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Acknowledgements

This project was built with the assistance of GitHub Copilot CLI + Claude Opus 4.6.

License

This project is licensed under the MIT License. See the LICENSE file for details.