Repository files navigation

This library provides convenient access to the Cloudflare REST API from server-side TypeScript or JavaScript.

The REST API documentation can be found ondevelopers.cloudflare.com. The full API of this library can be found inapi.md.

npm install cloudflare

The full API of this library can be found inapi.md.

importCloudflarefrom'cloudflare';constclient=newCloudflare({apiToken:process.env['CLOUDFLARE_API_TOKEN'],// This is the default and can be omitted});constzone=awaitclient.zones.create({account:{id:'023e105f4ecef8ad9ca31a8372d0c353'},name:'example.com',type:'full',});console.log(zone.id);

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

importCloudflarefrom'cloudflare';constclient=newCloudflare({apiToken:process.env['CLOUDFLARE_API_TOKEN'],// This is the default and can be omitted});constparams:Cloudflare.ZoneCreateParams={account:{id:'023e105f4ecef8ad9ca31a8372d0c353'},name:'example.com',type:'full',};constzone:Cloudflare.Zone=awaitclient.zones.create(params);

Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.

Request parameters that correspond to file uploads can be passed in many different forms:

• File (or an object with the same structure)
• afetchResponse (or an object with the same structure)
• anfs.ReadStream
• the return value of ourtoFile helper

importfsfrom'fs';importfetchfrom'node-fetch';importCloudflare,{toFile}from'cloudflare';constclient=newCloudflare();// If you have access to Node `fs` we recommend using `fs.createReadStream()`:awaitclient.apiGateway.userSchemas.create({zone_id:'023e105f4ecef8ad9ca31a8372d0c353',file:fs.createReadStream('/path/to/file'),kind:'openapi_v3',});// Or if you have the web `File` API you can pass a `File` instance:awaitclient.apiGateway.userSchemas.create({zone_id:'023e105f4ecef8ad9ca31a8372d0c353',file:newFile(['my bytes'],'file'),kind:'openapi_v3',});// You can also pass a `fetch` `Response`:awaitclient.apiGateway.userSchemas.create({zone_id:'023e105f4ecef8ad9ca31a8372d0c353',file:awaitfetch('https://somesite/file'),kind:'openapi_v3',});// Finally, if none of the above are convenient, you can use our `toFile` helper:awaitclient.apiGateway.userSchemas.create({zone_id:'023e105f4ecef8ad9ca31a8372d0c353',file:awaittoFile(Buffer.from('my bytes'),'file'),kind:'openapi_v3',});awaitclient.apiGateway.userSchemas.create({zone_id:'023e105f4ecef8ad9ca31a8372d0c353',file:awaittoFile(newUint8Array([0,1,2]),'file'),kind:'openapi_v3',});

When the library is unable to connect to the API,or if the API returns a non-success status code (i.e., 4xx or 5xx response),a subclass ofAPIError will be thrown:

constzone=awaitclient.zones.get({zone_id:'023e105f4ecef8ad9ca31a8372d0c353'}).catch(async(err)=>{if(errinstanceofCloudflare.APIError){console.log(err.status);// 400console.log(err.name);// BadRequestErrorconsole.log(err.headers);// {server: 'nginx', ...}}else{throwerr;}});

Error codes are as follows:

Certain errors will be automatically retried 2 times by default, with a short exponential backoff.Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,429 Rate Limit, and >=500 Internal errors will all be retried by default.

You can use themaxRetries option to configure or disable this:

// Configure the default for all requests:constclient=newCloudflare({maxRetries:0,// default is 2});// Or, configure per-request:awaitclient.zones.get({zone_id:'023e105f4ecef8ad9ca31a8372d0c353'},{maxRetries:5,});

Requests time out after 1 minute by default. You can configure this with atimeout option:

// Configure the default for all requests:constclient=newCloudflare({timeout:20*1000,// 20 seconds (default is 1 minute)});// Override per-request:awaitclient.zones.edit({zone_id:'023e105f4ecef8ad9ca31a8372d0c353'},{timeout:5*1000,});

On timeout, anAPIConnectionTimeoutError is thrown.

Note that requests which time out will beretried twice by default.

List methods in the Cloudflare API are paginated.You can use thefor await … of syntax to iterate through items across all pages:

asyncfunctionfetchAllAccounts(params){constallAccounts=[];// Automatically fetches more pages as needed.forawait(constaccountofclient.accounts.list()){allAccounts.push(account);}returnallAccounts;}

Alternatively, you can request a single page at a time:

letpage=awaitclient.accounts.list();for(constaccountofpage.result){console.log(account);}// Convenience methods are provided for manually paginating:while(page.hasNextPage()){page=awaitpage.getNextPage();// ...}

The "raw"Response returned byfetch() can be accessed through the.asResponse() method on theAPIPromise type that all methods return.

You can also use the.withResponse() method to get the rawResponse along with the parsed data.

constclient=newCloudflare();constresponse=awaitclient.zones.create({account:{id:'023e105f4ecef8ad9ca31a8372d0c353'},name:'example.com',type:'full'}).asResponse();console.log(response.headers.get('X-My-Header'));console.log(response.statusText);// access the underlying Response objectconst{data:zone,response:raw}=awaitclient.zones.create({account:{id:'023e105f4ecef8ad9ca31a8372d0c353'},name:'example.com',type:'full'}).withResponse();console.log(raw.headers.get('X-My-Header'));console.log(zone.id);

This library is typed for convenient access to the documented API. If you need to access undocumentedendpoints, params, or response properties, the library can still be used.

To make requests to undocumented endpoints, you can useclient.get,client.post, and other HTTP verbs.Options on the client, such as retries, will be respected when making these requests.

awaitclient.post('/some/path',{body:{some_prop:'foo'},query:{some_query_arg:'bar'},});

To make requests using undocumented parameters, you may use// @ts-expect-error on the undocumentedparameter. This library doesn't validate at runtime that the request matches the type, so any extra values yousend will be sent as-is.

client.foo.create({foo:'my_param',bar:12,//@ts-expect-error baz is not yet publicbaz:'undocumented option',});

For requests with theGET verb, any extra params will be in the query, all other requests will send theextra param in the body.

If you want to explicitly send an extra argument, you can do so with thequery,body, andheaders requestoptions.

To access undocumented response properties, you may access the response object with// @ts-expect-error onthe response object, or cast the response object to the requisite type. Like the request params, we do notvalidate or strip extra properties from the response from the API.

By default, this library usesnode-fetch in Node, and expects a globalfetch function in other environments.

If you would prefer to use a global, web-standards-compliantfetch function even in a Node environment,(for example, if you are running Node with--experimental-fetch or using NextJS which polyfills withundici),add the following import before your first importfrom "Cloudflare":

// Tell TypeScript and the package to use the global web fetch instead of node-fetch.// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.import'cloudflare/shims/web';importCloudflarefrom'cloudflare';

To do the inverse, addimport "cloudflare/shims/node" (which does import polyfills).This can also be useful if you are getting the wrong TypeScript types forResponse (more details).

You may also provide a customfetch function when instantiating the client,which can be used to inspect or alter theRequest orResponse before/after each request:

import{fetch}from'undici';// as one exampleimportCloudflarefrom'cloudflare';constclient=newCloudflare({fetch:async(url:RequestInfo,init?:RequestInit):Promise<Response>=>{console.log('About to make a request',url,init);constresponse=awaitfetch(url,init);console.log('Got response',response);returnresponse;},});

Note that if given aDEBUG=true environment variable, this library will log all requests and responses automatically.This is intended for debugging purposes only and may change in the future without notice.

By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.

If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass anhttpAgent which is used for all requests (be they http or https), for example:

importhttpfrom'http';import{HttpsProxyAgent}from'https-proxy-agent';// Configure the default for all requests:constclient=newCloudflare({httpAgent:newHttpsProxyAgent(process.env.PROXY_URL),});// Override per-request:awaitclient.zones.delete({zone_id:'023e105f4ecef8ad9ca31a8372d0c353'},{httpAgent:newhttp.Agent({keepAlive:false}),},);

This package generally followsSemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use.
3. Changes that we do not expect to impact the vast majority of users in practice.

TypeScript >= 4.5 is supported.

The following runtimes are supported:

• Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
• Node.js 18 LTS or later (non-EOL) versions.
• Deno v1.28.0 or higher.
• Bun 1.0 or later.
• Cloudflare Workers.
• Vercel Edge Runtime.
• Jest 28 or greater with the"node" environment ("jsdom" is not supported at this time).
• Nitro v2.6 or greater.

Note that React Native is not supported at this time.

If you are interested in other runtime environments, please open or upvote an issue on GitHub.

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 contactCloudflare support.

• Community triage meeting

Seethe contributing documentation.