The official Go library for the Cloudflare API https://developers.cloudflare.com/api
Find a file
History 2026-11-09 19:06:25 -05:00
.devcontainer chore: improve devcontainer setup 2025-05-21 21:25:31 +00:00
.github release: 7.4.0 (#4318) 2026-05-29 11:17:14 -07:00
abuse_reports release: v7.15.0 2026-11-06 23:03:56 -05:00
accounts release: v7.15.0 2026-11-06 23:03:56 -05:00
acm release: v7.15.0 2026-11-06 23:03:56 -05:00
addressing release: v7.15.0 2026-11-06 23:03:56 -05:00
ai Build SDK 2026-11-03 23:47:46 -05:00
ai_audit Build SDK 2026-11-03 23:47:46 -05:00
ai_gateway release: v7.15.0 2026-11-06 23:03:56 -05:00
ai_search Build SDK 2026-11-03 23:47:46 -05:00
ai_security Build SDK 2026-11-03 23:47:46 -05:00
alerting Build SDK 2026-11-03 23:47:46 -05:00
api_gateway Build SDK 2026-11-03 23:47:46 -05:00
argo Build SDK 2026-11-03 23:47:46 -05:00
audit_logs Build SDK 2026-11-03 23:47:46 -05:00
basin_catalog Build SDK 2026-11-03 23:47:46 -05:00
billing Build SDK 2026-11-03 23:47:46 -05:00
bot_management Build SDK 2026-11-03 23:47:46 -05:00
botnet_feed Build SDK 2026-11-03 23:47:46 -05:00
brand_protection release: v7.15.0 2026-11-06 23:03:56 -05:00
browser_rendering Build SDK 2026-11-03 23:47:46 -05:00
cache Build SDK 2026-11-03 23:47:46 -05:00
calls Build SDK 2026-11-03 23:47:46 -05:00
certificate_authorities release: v7.15.0 2026-11-06 23:03:56 -05:00
client_certificates Build SDK 2026-11-03 23:47:46 -05:00
cloud_connector Build SDK 2026-11-03 23:47:46 -05:00
cloudforce_one release: v7.15.0 2026-11-06 23:03:56 -05:00
connectivity Build SDK 2026-11-03 23:47:46 -05:00
containers Build SDK 2026-11-03 23:47:46 -05:00
content_scanning Build SDK 2026-11-03 23:47:46 -05:00
csam_scanner Build SDK 2026-11-03 23:47:46 -05:00
custom_certificates Build SDK 2026-11-03 23:47:46 -05:00
custom_csrs Build SDK 2026-11-03 23:47:46 -05:00
custom_hostnames release: v7.15.0 2026-11-06 23:03:56 -05:00
custom_nameservers Build SDK 2026-11-03 23:47:46 -05:00
custom_pages Build SDK 2026-11-03 23:47:46 -05:00
d1 Build SDK 2026-11-03 23:47:46 -05:00
dcv_delegation Build SDK 2026-11-03 23:47:46 -05:00
ddos_protection Build SDK 2026-11-03 23:47:46 -05:00
diagnostics Build SDK 2026-11-03 23:47:46 -05:00
dls Build SDK 2026-11-03 23:47:46 -05:00
dns release: v7.15.0 2026-11-06 23:03:56 -05:00
dns_firewall Build SDK 2026-11-03 23:47:46 -05:00
docs/migration-guides docs: RequestValidity is not removed in v7.15.0 (still a live ssl enum) 2026-11-06 23:07:39 -05:00
durable_objects Build SDK 2026-11-03 23:47:46 -05:00
email_auth Build SDK 2026-11-03 23:47:46 -05:00
email_routing release: v7.15.0 2026-11-06 23:03:56 -05:00
email_security Build SDK 2026-11-03 23:47:46 -05:00
email_sending Build SDK 2026-11-03 23:47:46 -05:00
examples chore: add .keep files for examples and custom code directories 2024-01-08 20:31:09 +00:00
field_extractors Build SDK 2026-11-03 23:47:46 -05:00
filters Build SDK 2026-11-03 23:47:46 -05:00
firewall Build SDK 2026-11-03 23:47:46 -05:00
flagship Build SDK 2026-11-03 23:47:46 -05:00
fraud Build SDK 2026-11-03 23:47:46 -05:00
google_tag_gateway Build SDK 2026-11-03 23:47:46 -05:00
healthchecks Build SDK 2026-11-03 23:47:46 -05:00
hostnames Build SDK 2026-11-03 23:47:46 -05:00
hyperdrive Build SDK 2026-11-03 23:47:46 -05:00
iam Build SDK 2026-11-03 23:47:46 -05:00
images Build SDK 2026-11-03 23:47:46 -05:00
intel release: v7.15.0 2026-11-06 23:03:56 -05:00
internal release: v7.15.0 2026-11-06 23:03:56 -05:00
ips Build SDK 2026-11-03 23:47:46 -05:00
k2 Build SDK 2026-11-03 23:47:46 -05:00
keyless_certificates Build SDK 2026-11-03 23:47:46 -05:00
kv Build SDK 2026-11-03 23:47:46 -05:00
leaked_credential_checks Build SDK 2026-11-03 23:47:46 -05:00
lib chore: add .keep files for examples and custom code directories 2024-01-08 20:31:09 +00:00
load_balancers Build SDK 2026-11-03 23:47:46 -05:00
logpush Build SDK 2026-11-03 23:47:46 -05:00
logs Build SDK 2026-11-03 23:47:46 -05:00
magic_network_monitoring Build SDK 2026-11-03 23:47:46 -05:00
magic_transit Build SDK 2026-11-03 23:47:46 -05:00
managed_defense Build SDK 2026-11-03 23:47:46 -05:00
managed_transforms Build SDK 2026-11-03 23:47:46 -05:00
memberships Build SDK 2026-11-03 23:47:46 -05:00
monetization Build SDK 2026-11-03 23:47:46 -05:00
moq Build SDK 2026-11-03 23:47:46 -05:00
mtls_certificates Build SDK 2026-11-03 23:47:46 -05:00
network_interconnects release: v7.15.0 2026-11-06 23:03:56 -05:00
option Build SDK 2026-10-14 13:41:59 -05:00
organizations release: v7.15.0 2026-11-06 23:03:56 -05:00
origin_ca_certificates release: v7.15.0 2026-11-06 23:03:56 -05:00
origin_post_quantum_encryption Build SDK 2026-11-03 23:47:46 -05:00
origin_tls_client_auth Build SDK 2026-11-03 23:47:46 -05:00
origin_tls_compliance_modes Build SDK 2026-11-03 23:47:46 -05:00
packages/pagination chore(go): build sdk after custom code conflict 2026-10-22 16:00:05 -07:00
page_rules Build SDK 2026-11-03 23:47:46 -05:00
page_shield Build SDK 2026-11-03 23:47:46 -05:00
pages Build SDK 2026-11-03 23:47:46 -05:00
pipelines Build SDK 2026-11-03 23:47:46 -05:00
precursor Build SDK 2026-11-03 23:47:46 -05:00
queues Build SDK 2026-11-03 23:47:46 -05:00
r2 release: v7.15.0 2026-11-06 23:03:56 -05:00
r2_data_catalog Build SDK 2026-11-03 23:47:46 -05:00
radar release: v7.15.0 2026-11-06 23:03:56 -05:00
rate_limits Build SDK 2026-11-03 23:47:46 -05:00
realtime_kit release: v7.15.0 2026-11-06 23:03:56 -05:00
registrar Build SDK 2026-11-03 23:47:46 -05:00
registrar_sandbox Build SDK 2026-11-03 23:47:46 -05:00
request_tracers Build SDK 2026-11-03 23:47:46 -05:00
resource_sharing Build SDK 2026-11-03 23:47:46 -05:00
resource_tagging Build SDK 2026-11-03 23:47:46 -05:00
rules release: v7.15.0 2026-11-06 23:03:56 -05:00
rulesets Build SDK 2026-11-03 23:47:46 -05:00
rum Build SDK 2026-11-03 23:47:46 -05:00
schema_validation Build SDK 2026-11-03 23:47:46 -05:00
scripts release: v7.15.0 2026-11-06 23:03:56 -05:00
secrets_store release: v7.15.0 2026-11-06 23:03:56 -05:00
security_center Build SDK 2026-11-03 23:47:46 -05:00
security_txt Build SDK 2026-11-03 23:47:46 -05:00
shared release: v7.15.0 2026-11-06 23:03:56 -05:00
snippets Build SDK 2026-11-03 23:47:46 -05:00
spectrum Build SDK 2026-11-03 23:47:46 -05:00
speed Build SDK 2026-11-03 23:47:46 -05:00
ssl release: v7.15.0 2026-11-06 23:03:56 -05:00
stream Build SDK 2026-11-03 23:47:46 -05:00
tenant_custom_nameservers Build SDK 2026-11-03 23:47:46 -05:00
tenants release: v7.15.0 2026-11-06 23:03:56 -05:00
token_validation Build SDK 2026-11-03 23:47:46 -05:00
turnstile Build SDK 2026-11-03 23:47:46 -05:00
url_normalization Build SDK 2026-11-03 23:47:46 -05:00
url_scanner Build SDK 2026-11-03 23:47:46 -05:00
user Build SDK 2026-11-03 23:47:46 -05:00
vectorize Build SDK 2026-11-03 23:47:46 -05:00
vulnerability_scanner Build SDK 2026-11-03 23:47:46 -05:00
waiting_rooms Build SDK 2026-11-03 23:47:46 -05:00
web3 Build SDK 2026-11-03 23:47:46 -05:00
workers release: v7.15.0 2026-11-06 23:03:56 -05:00
workers_for_platforms release: v7.15.0 2026-11-06 23:03:56 -05:00
workflows Build SDK 2026-11-03 23:47:46 -05:00
zaraz Build SDK 2026-11-03 23:47:46 -05:00
zero_trust release: v7.15.0 2026-11-06 23:03:56 -05:00
zones release: v7.15.0 2026-11-06 23:03:56 -05:00
.gitignore release: 6.9.0 (#4237) 2026-04-03 11:24:22 -07:00
.release-please-manifest.json chore(release): prepare v7.14.0 2026-11-05 13:03:58 -05:00
.stats.yml release: v7.15.0 2026-11-06 23:03:56 -05:00
aliases.go Build SDK 2026-11-03 23:47:46 -05:00
analyticsquery.go Build SDK 2026-07-15 14:08:47 -05:00
analyticsquery_test.go Build SDK 2026-07-15 14:08:47 -05:00
analyticsquerydatasecurity.go Build SDK 2026-07-15 14:08:47 -05:00
analyticsquerydatasecuritycontentfinding.go Build SDK 2026-07-15 14:08:47 -05:00
analyticsquerydatasecuritycontentfinding_test.go Build SDK 2026-07-15 14:08:47 -05:00
analyticsquerydatasecurityfinding.go Build SDK 2026-07-15 14:08:47 -05:00
analyticsquerydatasecurityfinding_test.go Build SDK 2026-07-15 14:08:47 -05:00
api.md Build SDK 2026-10-29 14:46:09 -05:00
Brewfile chore(internal): codegen related update (#3270) 2024-10-02 00:03:44 +00:00
CHANGELOG-v7.2.0.md chore: remove dangling references for excluded resources 2026-05-15 16:24:22 -05:00
CHANGELOG.md docs: RequestValidity is not removed in v7.15.0 (still a live ssl enum) 2026-11-06 23:07:39 -05:00
client.go Build SDK 2026-10-29 14:46:09 -05:00
client_test.go Build SDK 2026-09-24 06:24:42 -05:00
CONTRIBUTING.md chore(go): set minimum go version to 1.26 2026-10-22 16:34:11 -07:00
default_http_client.go release: 7.4.0 (#4318) 2026-05-29 11:17:14 -07:00
field.go Build SDK 2026-07-15 14:08:47 -05:00
go.mod chore(go): build sdk after custom code conflict 2026-10-22 16:00:05 -07:00
go.sum fix v3 module path 2024-09-23 14:34:12 +10:00
LICENSE chore(api): update composite API spec 2026-01-07 17:39:35 +00:00
multipart_json_test.go fix(apiform): restore JSON multipart encoding clobbered by regeneration 2026-10-01 14:04:42 -07:00
paginationauto_test.go Build SDK 2026-11-03 23:47:46 -05:00
paginationmanual_test.go Build SDK 2026-11-03 23:47:46 -05:00
README.md chore(release): prepare v7.14.0 2026-11-05 13:03:58 -05:00
release-please-config.json feat: update via SDK Studio (#1518) 2024-03-08 16:24:21 +00:00
SECURITY.md chore: revert SECURITY.md and client_test.go changes 2026-07-24 18:46:07 -05:00
usage_test.go feat!: bump module path from v6 to v7 2026-05-18 10:59:21 -05:00

Cloudflare Go API Library

Go Reference

The Cloudflare Go library provides convenient access to the Cloudflare REST API from applications written in Go.

It is generated with Stainless.

Installation

import (
	"github.com/cloudflare/cloudflare-go/v7" // imported as cloudflare
)

Or to pin the version:

go get -u 'github.com/cloudflare/cloudflare-go/v7@v7.14.0'

Requirements

This library requires Go 1.26+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/cloudflare/cloudflare-go/v7"
	"github.com/cloudflare/cloudflare-go/v7/option"
	"github.com/cloudflare/cloudflare-go/v7/zones"
)

func main() {
	client := cloudflare.NewClient(
		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), // defaults to os.LookupEnv("CLOUDFLARE_API_TOKEN")
	)
	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")
kv.NamespaceValueUpdateParams{
	AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
	Value:     cloudflare.F[io.Reader](file),
}

// A file from a string
kv.NamespaceValueUpdateParams{
	AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
	Value:     cloudflare.F[io.Reader](strings.NewReader("my file contents")),
}

// With a custom filename and contentType
kv.NamespaceValueUpdateParams{
	AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
	Value:     cloudflare.FileParam(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),
}

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:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  2. Changes that we do not expect to impact the vast majority of users in practice.

Maintenance

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.