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.
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() {
api, err := cloudflare.New(os.Getenv("CLOUDFLARE_API_KEY"), os.Getenv("CLOUDFLARE_API_EMAIL"))
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
u, err := api.UserDetails(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Println(u)
}
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.
Contributing
Pull Requests are welcome, but please open an issue (or comment in an existing
issue) to discuss any non-trivial changes before submitting code.
License
BSD licensed. See the LICENSE file for details.