Note: This library is under active development as we expand it to cover our (expanding!) API. Consider the public API of this package a little unstable as we work towards a v1.0.
A Go library for interacting with Cloudflare's API v4. This library allows you to:
- Manage and automate changes to your DNS records within Cloudflare
- Manage and automate changes to your zones (domains) on Cloudflare, including adding new zones to your account
- List and modify the status of WAF (Web Application Firewall) rules for your zones
- Fetch Cloudflare's IP ranges for automating your firewall whitelisting
A command-line client, flarectl, is also available as part of this project.
The current feature list includes:
- Cache purging
- Cloudflare IPs
- Custom hostnames
- DNS Records
- Firewall (partial)
- Keyless SSL
- Load Balancing
- Logpush Jobs
- Organization Administration
- Origin CA
- Railgun administration
- Rate Limiting
- User Administration (partial)
- Virtual DNS Management
- Web Application Firewall (WAF)
- Zone Lockdown and User-Agent Block rules
- Zones
- Workers KV
- Notifications
- Gateway Locations
Pull Requests are welcome, but please open an issue (or comment in an existing issue) to discuss any non-trivial changes before submitting code.
You need a working Go environment.
go get github.com/cloudflare/cloudflare-go
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/cloudflare/cloudflare-go"
)
func main() {
// Construct a new API object
api, err := cloudflare.New(os.Getenv("CLOUDFLARE_API_KEY"), os.Getenv("CLOUDFLARE_API_EMAIL"))
if err != nil {
log.Fatal(err)
}
// Most API calls require a Context
ctx := context.Background()
// Fetch user details on the account
u, err := api.UserDetails(ctx)
if err != nil {
log.Fatal(err)
}
// Print user details
fmt.Println(u)
// Fetch the zone ID
id, err := api.ZoneIDByName("example.com") // Assuming example.com exists in your Cloudflare account already
if err != nil {
log.Fatal(err)
}
// Fetch zone details
zone, err := api.ZoneDetails(ctx, id)
if err != nil {
log.Fatal(err)
}
// Print zone details
fmt.Println(zone)
}Also refer to the API documentation for how to use this package in-depth.
BSD licensed. See the LICENSE file for details.