cloudflare-go

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.

Features

The current feature list includes:

• Cache purging
• Cloudflare IPs
• Custom hostnames
• DNS Firewall
• DNS Records
• Firewall (partial)
• Gateway Locations
• Keyless SSL
• Load Balancing
• Logpush Jobs
• Magic Transit / Magic WAN
• mTLS Certificate Store
• Notifications
• Organization Administration
• Origin CA
• Railgun administration
• Rate Limiting
• User Administration (partial)
• Web Application Firewall (WAF)
• Workers KV
• Zone cache settings
• Zone Lockdown and User-Agent Block rules
• Zones
• Managed Headers

Pull Requests are welcome, but please open an issue (or comment in an existing issue) to discuss any non-trivial changes before submitting code.

Installation

You need a working Go environment. We officially support only currently supported Go versions according to Go project's release policy.

go get github.com/cloudflare/cloudflare-go

Getting Started

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/cloudflare/cloudflare-go"
)

func main() {
	// Construct a new API object using a global API key
	api, err := cloudflare.New(os.Getenv("CLOUDFLARE_API_KEY"), os.Getenv("CLOUDFLARE_API_EMAIL"))
	// alternatively, you can use a scoped API token
	// api, err := cloudflare.NewWithAPIToken(os.Getenv("CLOUDFLARE_API_TOKEN"))
	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.

Experimental improvements

This library is starting to ship with experimental improvements that are not yet ready for production but will be introduced before the next major version. See experimental README for full details.

License

BSD licensed. See the LICENSE file for details.