Top Related Projects
DigitalOcean Go API client
AWS SDK for the Go programming language (In Maintenance Mode, End-of-Life on 07/31/2025). The AWS SDK for Go v2 is available here: https://github.com/aws/aws-sdk-go-v2
This repository is for active development of the Azure SDK for Go. For consumers of the SDK we recommend visiting our public developer docs at:
Quick Overview
Cloudflare-go is the official Go library for interacting with Cloudflare's API v4. It provides a comprehensive set of bindings for Cloudflare's services, allowing developers to manage and automate various aspects of their Cloudflare accounts programmatically.
Pros
- Officially maintained by Cloudflare, ensuring reliability and up-to-date API support
- Comprehensive coverage of Cloudflare's API endpoints
- Well-documented with clear examples and usage instructions
- Actively maintained with regular updates and improvements
Cons
- Some advanced features may require deeper understanding of Cloudflare's infrastructure
- API changes in Cloudflare may occasionally lead to breaking changes in the library
- Limited support for older Go versions (requires Go 1.17+)
Code Examples
- Creating a new DNS record:
record := cloudflare.DNSRecord{
Type: "A",
Name: "example.com",
Content: "192.0.2.1",
TTL: 1,
Proxied: cloudflare.BoolPtr(false),
}
response, err := api.CreateDNSRecord(context.Background(), zoneID, record)
if err != nil {
log.Fatal(err)
}
fmt.Printf("Created DNS record: %+v\n", response)
- Listing zones:
zones, err := api.ListZones(context.Background())
if err != nil {
log.Fatal(err)
}
for _, zone := range zones {
fmt.Printf("Zone: %s (ID: %s)\n", zone.Name, zone.ID)
}
- Purging cache:
purgeEverything := cloudflare.PurgeCacheRequest{
PurgeEverything: true,
}
resp, err := api.PurgeCache(context.Background(), zoneID, purgeEverything)
if err != nil {
log.Fatal(err)
}
fmt.Printf("Cache purge response: %+v\n", resp)
Getting Started
To start using cloudflare-go, follow these steps:
-
Install the library:
go get github.com/cloudflare/cloudflare-go
-
Import the library in your Go code:
import "github.com/cloudflare/cloudflare-go"
-
Create a new API client:
api, err := cloudflare.New(os.Getenv("CLOUDFLARE_API_KEY"), os.Getenv("CLOUDFLARE_API_EMAIL")) if err != nil { log.Fatal(err) }
-
Start using the API methods:
// Example: List zones zones, err := api.ListZones(context.Background()) if err != nil { log.Fatal(err) } for _, zone := range zones { fmt.Printf("Zone: %s\n", zone.Name) }
Remember to set the CLOUDFLARE_API_KEY
and CLOUDFLARE_API_EMAIL
environment variables with your Cloudflare API credentials before running your code.
Competitor Comparisons
DigitalOcean Go API client
Pros of godo
- More comprehensive documentation and examples
- Wider range of DigitalOcean services covered
- Active community and frequent updates
Cons of godo
- Limited to DigitalOcean services only
- Slightly more complex API structure
- Fewer third-party integrations
Code Comparison
godo:
client := godo.NewFromToken("your-api-token")
droplet, _, err := client.Droplets.Create(context.TODO(), &godo.DropletCreateRequest{
Name: "example-droplet",
Region: "nyc3",
Size: "s-1vcpu-1gb",
Image: godo.DropletCreateImage{
Slug: "ubuntu-20-04-x64",
},
})
cloudflare-go:
api, err := cloudflare.New("API_KEY", "EMAIL")
zoneID, err := api.ZoneIDByName("example.com")
record := cloudflare.DNSRecord{
Type: "A",
Name: "example.com",
Content: "198.51.100.4",
TTL: 120,
}
resp, err := api.CreateDNSRecord(zoneID, record)
Both libraries provide Go-idiomatic interfaces for interacting with their respective APIs. godo focuses on DigitalOcean's infrastructure services, while cloudflare-go specializes in Cloudflare's DNS and CDN functionalities. The choice between them depends on the specific cloud provider and services required for your project.
AWS SDK for the Go programming language (In Maintenance Mode, End-of-Life on 07/31/2025). The AWS SDK for Go v2 is available here: https://github.com/aws/aws-sdk-go-v2
Pros of aws-sdk-go
- More comprehensive coverage of AWS services
- Larger community and ecosystem
- Better documentation and examples
Cons of aws-sdk-go
- Larger and more complex codebase
- Steeper learning curve for beginners
- Potentially slower updates for new AWS features
Code Comparison
aws-sdk-go:
svc := s3.New(session.New())
input := &s3.ListObjectsInput{
Bucket: aws.String("my-bucket"),
}
result, err := svc.ListObjects(input)
cloudflare-go:
api, err := cloudflare.New(apiKey, user)
zoneID, err := api.ZoneIDByName("example.com")
records, err := api.DNSRecords(zoneID, cloudflare.DNSRecord{})
Both SDKs provide idiomatic Go interfaces for interacting with their respective services. aws-sdk-go tends to use more verbose input structs, while cloudflare-go often uses simpler function signatures.
aws-sdk-go is better suited for large-scale AWS projects with complex requirements, while cloudflare-go is more focused and easier to use for Cloudflare-specific tasks. The choice between them depends on the specific needs of your project and which service (AWS or Cloudflare) you're primarily working with.
This repository is for active development of the Azure SDK for Go. For consumers of the SDK we recommend visiting our public developer docs at:
Pros of azure-sdk-for-go
- Comprehensive coverage of Azure services
- Well-documented with extensive examples
- Regular updates and active maintenance
Cons of azure-sdk-for-go
- Larger codebase and potentially steeper learning curve
- More complex setup due to broader scope
- May include unnecessary dependencies for simple projects
Code Comparison
azure-sdk-for-go:
import (
"github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2021-03-01/compute"
"github.com/Azure/go-autorest/autorest/azure/auth"
)
client := compute.NewVirtualMachinesClient(subscriptionID)
client.Authorizer, _ = auth.NewAuthorizerFromEnvironment()
cloudflare-go:
import (
"github.com/cloudflare/cloudflare-go"
)
api, _ := cloudflare.New(apiKey, user)
The azure-sdk-for-go example demonstrates the setup for a specific service client (Virtual Machines), while cloudflare-go provides a simpler, unified client initialization. Azure's SDK requires more configuration but offers granular control over individual services. Cloudflare's SDK has a more straightforward setup, which can be advantageous for smaller projects or when working with a limited set of Cloudflare services.
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Cloudflare Go API Library
The Cloudflare Go library provides convenient access to the Cloudflare REST API from applications written in Go. The full API of this library can be found in api.md.
Installation
import (
"github.com/cloudflare/cloudflare-go/v4" // imported as cloudflare
)
Or to pin the version:
go get -u 'github.com/cloudflare/cloudflare-go/v4@v4.2.0'
Requirements
This library requires Go 1.18+.
Usage
The full API of this library can be found in api.md.
package main
import (
"context"
"fmt"
"github.com/cloudflare/cloudflare-go/v4"
"github.com/cloudflare/cloudflare-go/v4/option"
"github.com/cloudflare/cloudflare-go/v4/zones"
)
func main() {
client := cloudflare.NewClient(
option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), // defaults to os.LookupEnv("CLOUDFLARE_API_KEY")
option.WithAPIEmail("user@example.com"), // defaults to os.LookupEnv("CLOUDFLARE_EMAIL")
)
zone, err := client.Zones.New(context.TODO(), zones.ZoneNewParams{
Account: cloudflare.F(zones.ZoneNewParamsAccount{
ID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
}),
Name: cloudflare.F("example.com"),
Type: cloudflare.F(zones.TypeFull),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", zone.ID)
}
Request fields
All request parameters are wrapped in a generic Field
type,
which we use to distinguish zero values from null or omitted fields.
This prevents accidentally sending a zero value if you forget a required parameter,
and enables explicitly sending null
, false
, ''
, or 0
on optional parameters.
Any field not specified is not sent.
To construct fields with values, use the helpers String()
, Int()
, Float()
, or most commonly, the generic F[T]()
.
To send a null, use Null[T]()
, and to send a nonconforming value, use Raw[T](any)
. For example:
params := FooParams{
Name: cloudflare.F("hello"),
// Explicitly send `"description": null`
Description: cloudflare.Null[string](),
Point: cloudflare.F(cloudflare.Point{
X: cloudflare.Int(0),
Y: cloudflare.Int(1),
// In cases where the API specifies a given type,
// but you want to send something else, use `Raw`:
Z: cloudflare.Raw[int64](0.01), // sends a float
}),
}
Response objects
All fields in response structs are value types (not pointers or wrappers).
If a given field is null
, not present, or invalid, the corresponding field
will simply be its zero value.
All response structs also include a special JSON
field, containing more detailed
information about each property, which you can use like so:
if res.Name == "" {
// true if `"name"` is either not present or explicitly null
res.JSON.Name.IsNull()
// true if the `"name"` key was not present in the response JSON at all
res.JSON.Name.IsMissing()
// When the API returns data that cannot be coerced to the expected type:
if res.JSON.Name.IsInvalid() {
raw := res.JSON.Name.Raw()
legacyName := struct{
First string `json:"first"`
Last string `json:"last"`
}{}
json.Unmarshal([]byte(raw), &legacyName)
name = legacyName.First + " " + legacyName.Last
}
}
These .JSON
structs also include an Extras
map containing
any properties in the json response that were not specified
in the struct. This can be useful for API features not yet
present in the SDK.
body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions
This library uses the functional options pattern. Functions defined in the
option
package return a RequestOption
, which is a closure that mutates a
RequestConfig
. These options can be supplied to the client or at individual
requests. For example:
client := cloudflare.NewClient(
// Adds a header to every request made by the client
option.WithHeader("X-Some-Header", "custom_header_info"),
)
client.Zones.New(context.TODO(), ...,
// Override the header
option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
// Add an undocumented field to the request body, using sjson syntax
option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)
See the full list of request options.
Pagination
This library provides some conveniences for working with paginated list endpoints.
You can use .ListAutoPaging()
methods to iterate through items across all pages:
iter := client.Accounts.ListAutoPaging(context.TODO(), accounts.AccountListParams{})
// Automatically fetches more pages as needed.
for iter.Next() {
account := iter.Current()
fmt.Printf("%+v\n", account)
}
if err := iter.Err(); err != nil {
panic(err.Error())
}
Or you can use simple .List()
methods to fetch a single page and receive a standard response object
with additional helper methods like .GetNextPage()
, e.g.:
page, err := client.Accounts.List(context.TODO(), accounts.AccountListParams{})
for page != nil {
for _, account := range page.Result {
fmt.Printf("%+v\n", account)
}
page, err = page.GetNextPage()
}
if err != nil {
panic(err.Error())
}
Errors
When the API returns a non-success status code, we return an error with type
*cloudflare.Error
. This contains the StatusCode
, *http.Request
, and
*http.Response
values of the request, as well as the JSON of the error body
(much like other response objects in the SDK).
To handle errors, we recommend that you use the errors.As
pattern:
_, err := client.Zones.Get(context.TODO(), zones.ZoneGetParams{
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
})
if err != nil {
var apierr *cloudflare.Error
if errors.As(err, &apierr) {
println(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request
println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
}
panic(err.Error()) // GET "/zones/{zone_id}": 400 Bad Request { ... }
}
When other errors occur, they are returned unwrapped; for example,
if HTTP transport fails, you might receive *url.Error
wrapping *net.OpError
.
Timeouts
Requests do not time out by default; use context to configure a timeout for a request lifecycle.
Note that if a request is retried, the context timeout does not start over.
To set a per-retry timeout, use option.WithRequestTimeout()
.
// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Zones.Edit(
ctx,
zones.ZoneEditParams{
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
},
// This sets the per-retry timeout
option.WithRequestTimeout(20*time.Second),
)
File uploads
Request parameters that correspond to file uploads in multipart requests are typed as
param.Field[io.Reader]
. The contents of the io.Reader
will by default be sent as a multipart form
part with the file name of "anonymous_file" and content-type of "application/octet-stream".
The file name and content-type can be customized by implementing Name() string
or ContentType() string
on the run-time type of io.Reader
. Note that os.File
implements Name() string
, so a
file returned by os.Open
will be sent with the file name on disk.
We also provide a helper cloudflare.FileParam(reader io.Reader, filename string, contentType string)
which can be used to wrap any io.Reader
with the appropriate file name and content type.
// A file from the file system
file, err := os.Open("/path/to/file")
api_gateway.UserSchemaNewParams{
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
File: cloudflare.F[io.Reader](file),
Kind: cloudflare.F(api_gateway.UserSchemaNewParamsKindOpenAPIV3),
}
// A file from a string
api_gateway.UserSchemaNewParams{
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
File: cloudflare.F[io.Reader](strings.NewReader("my file contents")),
Kind: cloudflare.F(api_gateway.UserSchemaNewParamsKindOpenAPIV3),
}
// With a custom filename and contentType
api_gateway.UserSchemaNewParams{
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
File: cloudflare.FileParam(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),
Kind: cloudflare.F(api_gateway.UserSchemaNewParamsKindOpenAPIV3),
}
Retries
Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.
You can use the WithMaxRetries
option to configure or disable this:
// Configure the default for all requests:
client := cloudflare.NewClient(
option.WithMaxRetries(0), // default is 2
)
// Override per-request:
client.Zones.Get(
context.TODO(),
zones.ZoneGetParams{
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
},
option.WithMaxRetries(5),
)
Accessing raw response data (e.g. response headers)
You can access the raw HTTP response data by using the option.WithResponseInto()
request option. This is useful when
you need to examine response headers, status codes, or other details.
// Create a variable to store the HTTP response
var response *http.Response
zone, err := client.Zones.New(
context.TODO(),
zones.ZoneNewParams{
Account: cloudflare.F(zones.ZoneNewParamsAccount{
ID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
}),
Name: cloudflare.F("example.com"),
Type: cloudflare.F(zones.TypeFull),
},
option.WithResponseInto(&response),
)
if err != nil {
// handle error
}
fmt.Printf("%+v\n", zone)
fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
Making custom/undocumented requests
This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.
Undocumented endpoints
To make requests to undocumented endpoints, you can use client.Get
, client.Post
, and other HTTP verbs.
RequestOptions
on the client, such as retries, will be respected when making these requests.
var (
// params can be an io.Reader, a []byte, an encoding/json serializable object,
// or a "â¦Params" struct defined in this library.
params map[string]interface{}
// result can be an []byte, *http.Response, a encoding/json deserializable object,
// or a model defined in this library.
result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
â¦
}
Undocumented request params
To make requests using undocumented parameters, you may use either the option.WithQuerySet()
or the option.WithJSONSet()
methods.
params := FooNewParams{
ID: cloudflare.F("id_xxxx"),
Data: cloudflare.F(FooNewParamsData{
FirstName: cloudflare.F("John"),
}),
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties
To access undocumented response properties, you may either access the raw JSON of the response as a string
with result.JSON.RawJSON()
, or get the raw JSON of a particular field on the result with
result.JSON.Foo.Raw()
.
Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields()
which returns the extra fields as a map[string]Field
.
Middleware
We provide option.WithMiddleware
which applies the given
middleware to requests.
func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
// Before the request
start := time.Now()
LogReq(req)
// Forward the request to the next handler
res, err = next(req)
// Handle stuff after the request
end := time.Now()
LogRes(res, err, start - end)
return res, err
}
client := cloudflare.NewClient(
option.WithMiddleware(Logger),
)
When multiple middlewares are provided as variadic arguments, the middlewares
are applied left to right. If option.WithMiddleware
is given
multiple times, for example first in the client then the method, the
middleware in the client will run first and the middleware given in the method
will run next.
You may also replace the default http.Client
with
option.WithHTTPClient(client)
. Only one http client is
accepted (this overwrites any previous client) and receives requests after any
middleware has been applied.
Semantic versioning
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes that only affect static types, without breaking runtime behavior.
- Changes to library internals which are technically public but not intended or documented for external use.
- Changes that we do not expect to impact the vast majority of users in practice.
Maintenance
This SDK is actively maintained, however, many issues are tracked outside of GitHub on internal Cloudflare systems. Members of the community are welcome to join and discuss your issues during our twice monthly triage meetings. For urgent issues, please contact Cloudflare support.
Contributing
Top Related Projects
DigitalOcean Go API client
AWS SDK for the Go programming language (In Maintenance Mode, End-of-Life on 07/31/2025). The AWS SDK for Go v2 is available here: https://github.com/aws/aws-sdk-go-v2
This repository is for active development of the Azure SDK for Go. For consumers of the SDK we recommend visiting our public developer docs at:
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot