The highest tagged major version is
README
¶
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/v2" // imported as cloudflare
)
Or to pin the version:
go get -u 'github.com/cloudflare/cloudflare-go/v2@v2.0.0-beta.9'
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/v2"
"github.com/cloudflare/cloudflare-go/v2/option"
"github.com/cloudflare/cloudflare-go/v2/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")
)
zoneNewResponse, 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.ZoneNewParamsTypeFull),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", zoneNewResponse.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 repsonse 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() {
accountListResponse := iter.Current()
fmt.Printf("%+v\n", accountListResponse)
}
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),
)
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),
)
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 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).
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.
Documentation
¶
Index ¶
- func Bool(value bool) param.Field[bool]
- func F[T any](value T) param.Field[T]
- func Float(value float64) param.Field[float64]
- func Int(value int64) param.Field[int64]
- func Null[T any]() param.Field[T]
- func Raw[T any](value any) param.Field[T]
- func String(value string) param.Field[string]
- type Client
- type Error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func F ¶
F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.
func Int ¶
Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.
func Raw ¶
Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).
Types ¶
type Client ¶
type Client struct {
Options []option.RequestOption
Accounts *accounts.AccountService
OriginCACertificates *origin_ca_certificates.OriginCACertificateService
IPs *ips.IPService
Memberships *memberships.MembershipService
User *user.UserService
Zones *zones.ZoneService
LoadBalancers *load_balancers.LoadBalancerService
Cache *cache.CacheService
SSL *ssl.SSLService
Subscriptions *subscriptions.SubscriptionService
ACM *acm.ACMService
Argo *argo.ArgoService
AvailablePlans *available_plans.AvailablePlanService
AvailableRatePlans *available_rate_plans.AvailableRatePlanService
CertificateAuthorities *certificate_authorities.CertificateAuthorityService
ClientCertificates *client_certificates.ClientCertificateService
CustomCertificates *custom_certificates.CustomCertificateService
CustomHostnames *custom_hostnames.CustomHostnameService
CustomNameservers *custom_nameservers.CustomNameserverService
DNS *dns.DNSService
DNSSEC *dnssec.DNSSECService
EmailRouting *email_routing.EmailRoutingService
Filters *filters.FilterService
Firewall *firewall.FirewallService
Healthchecks *healthchecks.HealthcheckService
KeylessCertificates *keyless_certificates.KeylessCertificateService
Logpush *logpush.LogpushService
Logs *logs.LogService
OriginTLSClientAuth *origin_tls_client_auth.OriginTLSClientAuthService
Pagerules *pagerules.PageruleService
RateLimits *rate_limits.RateLimitService
SecondaryDNS *secondary_dns.SecondaryDNSService
WaitingRooms *waiting_rooms.WaitingRoomService
Web3 *web3.Web3Service
Workers *workers.WorkerService
KV *kv.KVService
DurableObjects *durable_objects.DurableObjectService
Queues *queues.QueueService
ManagedHeaders *managed_headers.ManagedHeaderService
PageShield *page_shield.PageShieldService
Rulesets *rulesets.RulesetService
URLNormalization *url_normalization.URLNormalizationService
Spectrum *spectrum.SpectrumService
Addressing *addressing.AddressingService
AuditLogs *audit_logs.AuditLogService
Billing *billing.BillingService
BrandProtection *brand_protection.BrandProtectionService
Diagnostics *diagnostics.DiagnosticService
Images *images.ImageService
Intel *intel.IntelService
MagicTransit *magic_transit.MagicTransitService
MagicNetworkMonitoring *magic_network_monitoring.MagicNetworkMonitoringService
MTLSCertificates *mtls_certificates.MTLSCertificateService
Pages *pages.PageService
PCAPs *pcaps.PCAPService
Registrar *registrar.RegistrarService
RequestTracers *request_tracers.RequestTracerService
Rules *rules.RuleService
Storage *storage.StorageService
Stream *stream.StreamService
Alerting *alerting.AlertingService
D1 *d1.D1Service
R2 *r2.R2Service
WARPConnector *warp_connector.WARPConnectorService
WorkersForPlatforms *workers_for_platforms.WorkersForPlatformService
ZeroTrust *zero_trust.ZeroTrustService
Challenges *challenges.ChallengeService
Hyperdrive *hyperdrive.HyperdriveService
RUM *rum.RUMService
Vectorize *vectorize.VectorizeService
URLScanner *url_scanner.URLScannerService
Radar *radar.RadarService
BotManagement *bot_management.BotManagementService
OriginPostQuantumEncryption *origin_post_quantum_encryption.OriginPostQuantumEncryptionService
Speed *speed.SpeedService
DCVDelegation *dcv_delegation.DCVDelegationService
Hostnames *hostnames.HostnameService
Snippets *snippets.SnippetService
Calls *calls.CallService
CloudforceOne *cloudforce_one.CloudforceOneService
}
Client creates a struct with services and top level methods that help with interacting with the cloudflare API. You should not instantiate this client directly, and instead use the NewClient method instead.
func NewClient ¶
func NewClient(opts ...option.RequestOption) (r *Client)
NewClient generates a new client with the default option read from the environment (CLOUDFLARE_API_KEY, CLOUDFLARE_EMAIL, CLOUDFLARE_API_TOKEN, CLOUDFLARE_API_USER_SERVICE_KEY). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.
Source Files
Directories