https://github.com/georg-jung/fluentcloudflare
A fluent .Net Standard 2.0 wrapper for the Cloudflare API v4.
https://github.com/georg-jung/fluentcloudflare
cloudflare fluent-api fluent-design httpclient rest restful-api
Last synced: 13 days ago
JSON representation
A fluent .Net Standard 2.0 wrapper for the Cloudflare API v4.
- Host: GitHub
- URL: https://github.com/georg-jung/fluentcloudflare
- Owner: georg-jung
- License: mit
- Created: 2019-12-15T21:02:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-18T09:49:11.000Z (almost 3 years ago)
- Last Synced: 2025-04-10T07:05:28.379Z (14 days ago)
- Topics: cloudflare, fluent-api, fluent-design, httpclient, rest, restful-api
- Language: C#
- Homepage:
- Size: 136 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# FluentCloudflare
[](https://dev.azure.com/georg-jung/FluentCloudflare/_build/latest?definitionId=4&branchName=master)
[](https://www.nuget.org/packages/FluentCloudflare/)
[](https://dependabot.com)
This .Net Standard 2.0 library lets you consume the [Cloudflare REST API v4](https://api.cloudflare.com/) using a fluent syntax. It enables you to build requests and parse their results with ease. Bring your own `HttpClient`.
Please note this is currently in active development and the API is likely to change. For recent changes and updating instructions see the [Changelog](CHANGELOG.md).
## Getting Started
* [NuGet Package](https://www.nuget.org/packages/FluentCloudflare/)
* `PM> Install-Package FluentCloudflare`
```c#
using FluentCloudflare;
using FluentCloudflare.Extensions;
using var hc = new HttpClient();
var context = Cloudflare.WithToken(YourApiToken); // or .WithKey(ApiKey, "[email protected]");
// Get all zones of all accounts which exactly match the given name - in this case exactly one.
var zones = await context.Zones.List()
.WithName("cloudflare-api-debug.com")
.CallAsync(hc);
var zone = zones.First();
// We dont need to start every request from scratch.
var zoneCtx = context.Zone(zone.Id);
var dns = zoneCtx.Dns;
// Notice the call to ParseAsync instead of CallAsync. This way we dont get the
// result contained in the response but the whole response.
// Actually, CallAsync is an extension method in FluentCloudflare.Extensions which uses ParseAsync internally.
var recordsResponse = await dns.List().PerPage(100).ParseAsync(hc);
if (recordsResponse.ResultInfo.TotalCount > 100)
Console.WriteLine("We got more than 100 DNS records! We may want to get more of them using paging...");
var records = recordsResponse.Unpack(); // or recordsResponse.Result, skipping validation of the call's success
var first = records.First();
await dns.Delete(first).CallAsync(hc);
await dns.Create(first.Type, $"new-{first.Name}", first.Content).CallAsync(hc);
```
## Features / Scope
The Cloudflare API offers quite many methods. While this library offers multiple layers of abstraction, making it easily extendable, it does not support the full API on the highest level. Supporting bigger parts of the API is subject to active development. Feel free to contribute and send PRs.
Currently, the following APIs are supported:
| Area | Supported | Comments |
| ------------- | ------------- | -------- |
| [Authorization](https://api.cloudflare.com/#getting-started-requests) | :white_check_mark: | API Tokens, API Keys and Origin CA Keys are supported |
| [DNS Records](https://api.cloudflare.com/#dns-records-for-a-zone-properties) | :white_check_mark: except [import](https://api.cloudflare.com/#dns-records-for-a-zone-import-dns-records) |
| [Cloudflare IPs](https://api.cloudflare.com/#cloudflare-ips-properties) | :white_check_mark: |
| [Zone](https://api.cloudflare.com/#zone-properties) | [List](https://api.cloudflare.com/#zone-list-zones), [create](https://api.cloudflare.com/#zone-create-zone), [purge all files](https://api.cloudflare.com/#zone-purge-all-files) and [purge by url](https://api.cloudflare.com/#zone-purge-files-by-url)
| [Accounts](https://api.cloudflare.com/#accounts-properties) | [List](https://api.cloudflare.com/#accounts-list-accounts) and [get](https://api.cloudflare.com/#accounts-account-details)
| [Origin CA](https://api.cloudflare.com/#origin-ca-properties) | [List](https://api.cloudflare.com/#origin-ca-list-certificates) and [get](https://api.cloudflare.com/#origin-ca-get-certificate)
If you have a requirement for a specific area feel free to open an issue.
## Disclaimer
I'm not related to Cloudflare in any way. This is no official product.