cloudflare 2.8.0 | Documentation

cloudflare

2.8.0

Cloudflare
DNSRecords ▸
- Instance members
- #edit
- #browse
- #export
- #del
- #read
- #add
EnterpriseZoneWorkersScripts ▸
- Instance members
- #read
- #browse
- #edit
- #del
EnterpriseZoneWorkersRoutes ▸
- Instance members
- #browse
- #del
- #add
- #edit
- #read
EnterpriseZoneWorkersKVNamespaces ▸
- Instance members
- #edit
- #browse
- #add
- #del
EnterpriseZoneWorkersKV ▸
- Instance members
- #browse
- #add
- #read
- #del
- #addMulti
- #delMulti
IPs ▸
- Instance members
- #browse
PageRules ▸
- Instance members
- #edit
- #add
- #del
- #browse
- #read
Zones ▸
- Instance members
- #activationCheck
- #del
- #add
- #edit
- #read
- #purgeCache
- #browse
ZoneSettings ▸
- Instance members
- #read
- #edit
- #editAll
- #browse
ZoneCustomHostNames ▸
- Instance members
- #browse
- #read
- #edit
- #add
- #del
ZoneWorkers ▸
- Instance members
- #validate
ZoneWorkersScript ▸
- Instance members
- #read
- #read
- #del
ZoneWorkersRoutes ▸
- Instance members
- #browse
- #edit
- #read
- #add
- #del
User ▸
- Instance members
- #read
- #edit
Stream ▸
- Instance members
- #listVideos
- #videoDetails
- #deleteVideo

Need help reading this?

Cloudflare

Constructs and returns a new Cloudflare API client with the specified authentication.

new Cloudflare(auth: Object)

Parameters

auth (Object) The API authentication for an account

Name	Description
auth.email `string`	The account email address
auth.key `string`	The account API key
auth.token `string`	The account API token

Properties

dnsRecords (DNSRecords) : DNS Records instance

ips (IPs) : IPs instance

pageRules (PageRules) : Page Rules instance

zones (Zones) : Zones instance

zoneSettings (ZoneSettings) : Zone Settings instance

zoneCustomHostNames (ZoneCustomHostNames) : Zone Custom Host Names instance

user (User) : User instance

DNSRecords

DNSRecords represents the /zones/:zoneID/dns_records API endpoint.

new DNSRecords()

Extends Resource

Instance Members

▸ edit(zone_id, id, record)

edit allows for modification of the specified DNS Record

edit(zone_id: string, id: string, record: Object): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The DNS record ID being modified

record (Object) The modified dns record object

Returns

Promise<Object>: The DNS record object.

▸ browse(zone_id)

browse allows for listing all DNS Records for a zone

browse(zone_id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

Returns

Promise<Object>: The DNS browser response object.

▸ export(zone_id)

export retrieves all of a zone's DNS Records in BIND configuration format.

export(zone_id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

Returns

Promise<Object>: The DNS browser response object.

▸ del(zone_id, id)

del allows for deleting the specified DNS Record

del(zone_id: string, id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The DNS record ID to delete

Returns

Promise<Object>: The deleted DNS record object.

▸ read(zone_id, id)

read allows for retrieving the specified DNS Record

read(zone_id: string, id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The DNS record ID

Returns

Promise<Object>: The DNS record object.

▸ add(zone_id, record)

add allows for creating a new DNS record for a zone.

add(zone_id: string, record: Object): Promise<Object>

Parameters

zone_id (string) The zone ID

record (Object) The new DNS record object

Returns

Promise<Object>: The created DNS record object.

EnterpriseZoneWorkersScripts

EnterpriseZoneWorkersScripts represents the accounts/:accountId/workers/scripts API endpoint.

new EnterpriseZoneWorkersScripts()

Extends Resource

Instance Members

▸ read(account_id, name)

read retrieves a single workers script

read(account_id: string, name: string): Promise<Object>

Parameters

account_id (string) The enterprise account ID

name (string) The script name

Returns

Promise<Object>: The workers script response object.

▸ browse(account_id, name)

browse allows for listing all the workers scripts

browse(account_id: string, name: string): Promise<Object>

Parameters

account_id (string) The enterprise account ID

name (string) The script name

Returns

Promise<Object>: The zone workers script response object.

▸ edit(account_id, name, script)

edit uploads a new version of a workers script

edit(account_id: string, name: string, script: string): Promise<Object>

Parameters

account_id (string) The enterprise account ID

name (string) The script name

script (string) The script

Returns

Promise<Object>: The response object

▸ del(account_id, name)

del allows for deleting the specified workers script

del(account_id: string, name: string): Promise<Object>

Parameters

account_id (string) The enterprise account ID

name (string) The script name

Returns

Promise<Object>: The deleted zone workers script response object.

EnterpriseZoneWorkersRoutes

EnterpriseZoneWorkersRoutes represents the zones/:zoneId/workers/routes API endpoint.

new EnterpriseZoneWorkersRoutes()

Extends Resource

Instance Members

▸ browse(zone_id)

browse allows for listing all of a zone's workers routes

browse(zone_id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

Returns

Promise<Object>: The route browse response object.

▸ del(zone_id, id)

del allows for removing a workers routes

del(zone_id: string, id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The route ID to delete

Returns

Promise<Object>: The custom route response object.

▸ add(zone_id, config)

add allows for creating a workers route

add(zone_id: string, config: Object): Promise<Object>

Parameters

zone_id (string) The zone ID

config (Object) The new route object

Returns

Promise<Object>: The custom route response object.

▸ edit(zone_id, id, config)

edit allows for modifying a specific zone's workers

edit(zone_id: string, id: string, config: Object): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The route ID

config (Object) The modified route object

Returns

Promise<Object>: The custom hostname response object.

▸ read(zone_id, id)

read allows for retrieving a specific zone's workers route

read(zone_id: string, id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The route ID

Returns

Promise<Object>: The route response object.

EnterpriseZoneWorkersKVNamespaces

EnterpriseZoneWorkersKVNamespaces represents the accounts/:accountId/storage/kv/namespaces API endpoint.

new EnterpriseZoneWorkersKVNamespaces()

Extends Resource

Instance Members

▸ edit(account_id, id, config)

edit allows for renaming a workers namespace

edit(account_id: string, id: string, config: Object): Promise<Object>

Parameters

account_id (string) The account ID

id (string) The namespace id

config (Object) The namespace object

Returns

Promise<Object>: The namespace response object.

▸ browse(account_id)

browse allows for listing all of a zone's workers namespaces

browse(account_id: string): Promise<Object>

Parameters

account_id (string) The account ID

Returns

Promise<Object>: The namespace response object.

▸ add(account_id, config)

add allows for creating a workers namespace

add(account_id: string, config: Object): Promise<Object>

Parameters

account_id (string) The account ID

config (Object) The namespace object

Returns

Promise<Object>: The namespace response object.

▸ del(account_id, id)

del allows for deleting a workers namespace

del(account_id: string, id: string): Promise<Object>

Parameters

account_id (string) The account ID

id (string) The namespace id

Returns

Promise<Object>: The namespace response object.

EnterpriseZoneWorkersKV

EnterpriseZoneWorkersKV represents the accounts/:accountId/storage/kv/namespaces API endpoint.

new EnterpriseZoneWorkersKV()

Extends Resource

Instance Members

▸ browse(account_id, namespace_id)

browse allows for listing all the keys of a namespace

browse(account_id: string, namespace_id: string): Promise<Object>

Parameters

account_id (string) The account ID

namespace_id (string) The namespace ID

Returns

Promise<Object>: The KV response object.

▸ add(account_id, namespace_id, value)

add allows for creating a key-value pair in a namespace

add(account_id: string, namespace_id: string, value: string): Promise<Object>

Parameters

account_id (string) The account ID

namespace_id (string) The namespace ID

value (string) The value to store

Returns

Promise<Object>: The KV response object

▸ read(account_id, namespace_id, key_name)

read allows for reading the contents of key in a namespace

read(account_id: string, namespace_id: string, key_name: string): Promise<Object>

Parameters

account_id (string) The account ID

namespace_id (string) The namespace ID

key_name (string) The key name

Returns

Promise<Object>: The KV response object

▸ del(account_id, namespace_id, key_name)

del allows for deleting a key and its contents in a namespace

del(account_id: string, namespace_id: string, key_name: string): Promise<Object>

Parameters

account_id (string) The account ID

namespace_id (string) The namespace ID

key_name (string) The key name

Returns

Promise<Object>: The KV response object

▸ addMulti(account_id, namespace_id, data)

addMulti allows for creating multiple key-value pairs in a namespace

addMulti(account_id: string, namespace_id: string, data: Array<Object>): Promise<Object>

Parameters

account_id (string) The account ID

namespace_id (string) The namespace ID

data (Array<Object>) An array containing key-vaue pair Objects to add

Returns

Promise<Object>: The KV response object

▸ delMulti(account_id, namespace_id, data)

delMulti allows for deleting multiple key-value pairs in a namespace

delMulti(account_id: string, namespace_id: string, data: Array<String>): Promise<Object>

Parameters

account_id (string) The account ID

namespace_id (string) The namespace ID

data (Array<String>) The array with keys to delete

Returns

Promise<Object>: The KV response object

IPs

IPs represents the /ips API endpoint.

new IPs()

Extends Resource

Instance Members

▸ browse()

browse returns a Promise of the current Cloudflare IPv4 and IPv6 addresses.

browse(): Promise<Object>

Returns

Promise<Object>: The IPv4 and IPv6 addresses

Example

// logs the fetched IP addresses
cf.ips.browse(console.log)

PageRules

PageRules represents the /zones/:zoneID/pagerules API endpoint.

new PageRules()

Extends Resource

Instance Members

▸ edit(id, page_rule)

edit allows for modifying a specific zone

edit(id: string, page_rule: Object): Promise<Object>

Parameters

id (string) The page rule ID

page_rule (Object) The modified page rule object

Returns

Promise<Object>: The page rule response object.

▸ add(zone)

add allows for creating a new zone

add(zone: Object): Promise<Object>

Parameters

zone (Object) The new page rule object

Returns

Promise<Object>: The page rule response object.

▸ del(id)

del allows for removing a new zone

del(id: string): Promise<Object>

Parameters

id (string) The page rule ID to delete

Returns

Promise<Object>: The page rule response object.

▸ browse()

browse allows for listing all the page rules

browse(): Promise<Object>

Returns

Promise<Object>: The page rules browse response object.

▸ read(id)

read allows for retrieving a specific page rule

read(id: string): Promise<Object>

Parameters

id (string) The page rule ID

Returns

Promise<Object>: The page rule response object.

Zones

Zones represents the /zones API endpoint.

new Zones()

Extends Resource

Instance Members

▸ activationCheck(id)

activationCheck initiates another zone activation check

activationCheck(id: string): Promise<Object>

Parameters

id (string) The zone ID

Returns

Promise<Object>: The response object

▸ del(id)

del allows for removing a new zone

del(id: string): Promise<Object>

Parameters

id (string) The zone ID to delete

Returns

Promise<Object>: The zone response object.

▸ add(zone)

add allows for creating a new zone

add(zone: Object): Promise<Object>

Parameters

zone (Object) The new zone object

Returns

Promise<Object>: The zone response object.

▸ edit(id, zone)

edit allows for modifying a specific zone

edit(id: string, zone: Object): Promise<Object>

Parameters

id (string) The zone ID

zone (Object) The modified zone object

Returns

Promise<Object>: The zone response object.

▸ read(id)

read allows for retrieving a specific zone

read(id: string): Promise<Object>

Parameters

id (string) The zone ID

Returns

Promise<Object>: The zone response object.

▸ purgeCache(id, params?)

purgeCache purges files from Cloudflare's cache

purgeCache(id: string, params: Object?): Promise<Object>

Parameters

id (string) The zone ID

params (Object?) Parameters to restrict purges

Name	Description
params.files `(Array<string> \| Array<Object>)?`	Files to purge from the Cloudflare cache
params.tags `Array<string>?`	Purge files served with these Cache-Tag headers
params.hosts `Array<string>?`	Purge files that match these hosts

Returns

Promise<Object>: The response object

▸ browse()

browse allows for listing all the zones

browse(): Promise<Object>

Returns

Promise<Object>: The zone browse response object.

ZoneSettings

ZoneSettings represents the /zones/:zoneID/settings API endpoint.

new ZoneSettings()

Extends Resource

Instance Members

▸ read(id, setting)

read retrieves a single zone setting

read(id: string, setting: string): Promise<Object>

Parameters

id (string) The zone ID

setting (string) = The setting name

Returns

Promise<Object>: The zone settings response object.

▸ edit(id, setting, value)

edit modifies a single zone setting

edit(id: string, setting: string, value: (string | Object)): Promise<Object>

Parameters

id (string) The zone ID

setting (string) = The setting name

value ((string | Object)) The new zone setting

Returns

Promise<Object>: The zone settings response object.

▸ editAll(id, settings)

editAll allows for editing of all the zone settings at once

editAll(id: string, settings: Object): Promise<Object>

Parameters

id (string) The zone ID

settings (Object) The modified zone settings

Returns

Promise<Object>: The response object

▸ browse(id)

browse allows for listing all the zone settings

browse(id: string): Promise<Object>

Parameters

id (string) The zone ID

Returns

Promise<Object>: The zone settings response object.

ZoneCustomHostNames

ZoneCustomHostNames represents the /zones/:zoneID/custom_hostnames API endpoint.

new ZoneCustomHostNames()

Extends Resource

Instance Members

▸ browse(zone_id)

browse allows for listing all of a zone's custom hostanames

browse(zone_id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

Returns

Promise<Object>: The custom hostname browse response object.

▸ read(zone_id, id)

read allows for retrieving a specific custom hostname

read(zone_id: string, id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The custom hostname ID

Returns

Promise<Object>: The custom hostname response object.

▸ edit(zone_id, id, config)

edit allows for modifying a specific zone

edit(zone_id: string, id: string, config: Object): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The custom hostname ID

config (Object) The modified custom hostname object

Returns

Promise<Object>: The custom hostname response object.

▸ add(zone_id, config)

add allows for creating a new zone

add(zone_id: string, config: Object): Promise<Object>

Parameters

zone_id (string) The zone ID

config (Object) The new custom hostname object

Returns

Promise<Object>: The custom hostname response object.

▸ del(zone_id, id)

del allows for removing a new zone

del(zone_id: string, id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The custom hostname ID to delete

Returns

Promise<Object>: The custom hostname response object.

ZoneWorkers

ZoneWorkers represents the /zones/:zoneId/workers API endpoint.

new ZoneWorkers()

Extends Resource

Instance Members

▸ validate(zoneId, script)

validate allows for validating a workers script

validate(zoneId: string, script: string): Promise<Object>

Parameters

zoneId (string) The zone ID

script (string) The worker script

Returns

Promise<Object>: The validate response object.

ZoneWorkersScript

ZoneWorkersScript represents the /zones/:zoneID/workers/script API endpoint.

new ZoneWorkersScript()

Extends Resource

Instance Members

▸ read(zone_id)

read retrieves a the current workers script

read(zone_id: string): Promise<Object>

Parameters

zone_id (string) The enterprise account ID

Returns

Promise<Object>: The workers script response object.

▸ read(zone_id, script)

read retrieves a the current workers script

read(zone_id: string, script: string): Promise<Object>

Parameters

zone_id (string) The enterprise account ID

script (string) The script

Returns

Promise<Object>: The workers script response object.

▸ del()

del allows for deleting the workers script

del(): Promise<Object>

Returns

Promise<Object>: The deleted zone workers script response object.

ZoneWorkersRoutes

ZoneWorkersRoutes represents the zones/:zoneId/workers/filters API endpoint.

new ZoneWorkersRoutes()

Extends Resource

Instance Members

▸ browse(zone_id)

browse allows for listing all of a zone's workers routes

browse(zone_id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

Returns

Promise<Object>: The route browse response object.

▸ edit(zone_id, id, config)

edit allows for modifying a specific zone's workers route

edit(zone_id: string, id: string, config: Object): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The route ID

config (Object) The modified route object

Returns

Promise<Object>: The custom hostname response object.

▸ read(zone_id, id)

read allows for retrieving a specific zone's workers route

read(zone_id: string, id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The route ID

Returns

Promise<Object>: The route response object.

▸ add(zone_id, config)

add allows for creating a workers route

add(zone_id: string, config: Object): Promise<Object>

Parameters

zone_id (string) The zone ID

config (Object) The new route object

Returns

Promise<Object>: The custom route response object.

▸ del(zone_id, id)

del allows for removing a workers route

del(zone_id: string, id: string): Promise<Object>

Parameters

zone_id (string) The zone ID

id (string) The route ID to delete

Returns

Promise<Object>: The custom route response object.

User

User represents the /user API endpoint.

new User()

Extends Resource

Instance Members

▸ read()

read returns the current user object

read(): Promise<Object>

Returns

Promise<Object>: The user object

▸ edit(user)

edit allows for modification of the current user

edit(user: Object): Promise<Object>

Parameters

user (Object) The modified user object

Returns

Promise<Object>: The user object

Stream

Stream represents the /accout/:id/stream API endpoint.

new Stream()

Extends Resource

Instance Members

▸ listVideos(accountId)

ListVideos retrieves all of a account's videos.

listVideos(accountId: string): Promise<Object>

Parameters

accountId (string) The account ID

Returns

Promise<Object>: The response object

▸ videoDetails(accountId, id)

VideoDetails retrieves details of a account's single video.

videoDetails(accountId: string, id: string): Promise<Object>

Parameters

accountId (string) The account ID

id (string) The video ID

Returns

Promise<Object>: The response object

▸ deleteVideo(accountId, id)

DeleteVideo deletes a account's single video.

deleteVideo(accountId: string, id: string): Promise<Object>

Parameters

accountId (string) The account ID

id (string) The video ID

Returns

Promise<Object>: The response object