Overview
Error Handling

Methods

API Documentation (API Version bleed)

Network/CDN/Zone/

DESCRIPTION

activate

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/activate

Description:

Activates a CDN Zone

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType'
cdn_user_idA positive integer value (i.e. 1 and up).
is_full_setupA boolean value (0 or 1).* Optional
  • Defaults to: 0
nameA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)* Required
subdomainsA comma separated string of subdomains used in CloudFlare partial setup. The subdomains can be (but don't have to be) separated by a ':' to specify where the subdomain redirects to instead of the default.* Required if:
  • is_full_setup is set to '0'
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).* Optional
cdnDetailsAn associative array of arbitrary keys and values.* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
friendlyPlanTagA string of text, containing no newlines or other control characters.* Optional
idA valid id number (a positive integer).
isFullZoneA boolean value (0 or 1).* Optional
nameA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
plan_tagA single word, consisting of only letters, digits, and underscores.* Optional
service_detailsAn associative array containing the fields:* Optional
 
checked_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time at which the site was last monitored at CloudFlare

created_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time and date at which the website was added to CloudFlare

development_mode

An integer value.

Whether or not the website is in development mode at CloudFlare

host

An associative array containing the fields:

The name and website of the place in which the website is physically hosted

 
nameOne or more words, consisting of only letters, digits, underscores, and one white space in between them.
websiteEither: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
id

A single word, consisting of only letters and digits.

The CloudFlare identifier for this website

meta

An associative array containing the fields:

Various metadata about the website, including options and settings

* Optional
 
custom_certificate_quotaA positive integer value (i.e. 1 and up).
multiple_railguns_allowedA boolean value (0 or 1).
page_rule_quotaA positive integer value (i.e. 1 and up).
phishing_detectedA boolean value (0 or 1).
stepA positive integer value (i.e. 1 and up).
wildcard_proxiableA boolean value (0 or 1).
modified_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

Time and date at which the website was last modified on CloudFlare

name

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The domain name of the website

name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The nameservers where the DNS for the domain is hosted

original_dnshost

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original provider of DNS for the domain

original_name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original nameservers that hosted the domain

* Optional
original_registrar

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The registrar that the domain was originally registered at

* Optional
owner

An associative array containing the fields:

Information about the CloudFlare user that owns this website

* Optional
 
emailA valid email address.
idA single word, consisting of only letters and digits.
typeA single word, consisting of only letters and digits.
paused

A boolean value (0 or 1).

Whether or not the site is paused at CloudFlare

permissions

An array of a permission string for a CloudFlare Site permission

The CloudFlare permissions available to the website

plan

An associative array containing the fields:

Information about the CloudFlare plan that the website is on

 
can_subscribeA boolean value (0 or 1).* Optional
currencyA single word, consisting of only letters and digits.
externally_managedA boolean value (0 or 1).
frequencyA single word, consisting of only letters and digits.
idA string.
is_subscribedA boolean value (0 or 1).
legacy_idA single word, consisting of only letters and digits.
nameA string of text, containing no newlines or other control characters.
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
status

One of: 'active', 'deactivated', 'deleted', 'initializing', 'moved', 'pending'

The CloudFlare status of the website (active, pending, initializing, moved, deleted, deactivated)

type

One of: 'full', 'partial'

What type of setup was used at CloudFlare to add the domain (full or partial)

subdomainsA string of text, containing no newlines or other control characters.* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

analytics

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/analytics

Description:

Parameters:

ParameterTypeNotes
continuousA boolean value (0 or 1).
sinceA string of text, containing no newlines or other control characters.
uniq_idA six-character identifier, containing only capital letters and digits.* Required
untilA string of text, containing no newlines or other control characters.

Returns:

FieldType
dataAn associative array containing the fields:
 
analyticsAn associative array of arbitrary keys and values.
queryAn associative array of arbitrary keys and values.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

create

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/create

Description:

Creates a new CDN Zone

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType'
plan_tagA single word, consisting of only letters, digits, and underscores.* Required
typeA valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long.* Optional
  • Defaults to: CDN.Zone.CF

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).* Optional
cdnDetailsAn associative array of arbitrary keys and values.* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
friendlyPlanTagA string of text, containing no newlines or other control characters.* Optional
idA valid id number (a positive integer).
isFullZoneA boolean value (0 or 1).* Optional
nameA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
plan_tagA single word, consisting of only letters, digits, and underscores.* Optional
service_detailsAn associative array containing the fields:* Optional
 
checked_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time at which the site was last monitored at CloudFlare

created_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time and date at which the website was added to CloudFlare

development_mode

An integer value.

Whether or not the website is in development mode at CloudFlare

host

An associative array containing the fields:

The name and website of the place in which the website is physically hosted

 
nameOne or more words, consisting of only letters, digits, underscores, and one white space in between them.
websiteEither: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
id

A single word, consisting of only letters and digits.

The CloudFlare identifier for this website

meta

An associative array containing the fields:

Various metadata about the website, including options and settings

* Optional
 
custom_certificate_quotaA positive integer value (i.e. 1 and up).
multiple_railguns_allowedA boolean value (0 or 1).
page_rule_quotaA positive integer value (i.e. 1 and up).
phishing_detectedA boolean value (0 or 1).
stepA positive integer value (i.e. 1 and up).
wildcard_proxiableA boolean value (0 or 1).
modified_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

Time and date at which the website was last modified on CloudFlare

name

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The domain name of the website

name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The nameservers where the DNS for the domain is hosted

original_dnshost

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original provider of DNS for the domain

original_name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original nameservers that hosted the domain

* Optional
original_registrar

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The registrar that the domain was originally registered at

* Optional
owner

An associative array containing the fields:

Information about the CloudFlare user that owns this website

* Optional
 
emailA valid email address.
idA single word, consisting of only letters and digits.
typeA single word, consisting of only letters and digits.
paused

A boolean value (0 or 1).

Whether or not the site is paused at CloudFlare

permissions

An array of a permission string for a CloudFlare Site permission

The CloudFlare permissions available to the website

plan

An associative array containing the fields:

Information about the CloudFlare plan that the website is on

 
can_subscribeA boolean value (0 or 1).* Optional
currencyA single word, consisting of only letters and digits.
externally_managedA boolean value (0 or 1).
frequencyA single word, consisting of only letters and digits.
idA string.
is_subscribedA boolean value (0 or 1).
legacy_idA single word, consisting of only letters and digits.
nameA string of text, containing no newlines or other control characters.
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
status

One of: 'active', 'deactivated', 'deleted', 'initializing', 'moved', 'pending'

The CloudFlare status of the website (active, pending, initializing, moved, deleted, deactivated)

type

One of: 'full', 'partial'

What type of setup was used at CloudFlare to add the domain (full or partial)

subdomainsA string of text, containing no newlines or other control characters.* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

delete

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/delete

Description:

Remove a CDN Zone

Parameters:

ParameterTypeNotes
forceA boolean value (0 or 1).* Optional
  • Defaults to: 0
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
deletedA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/details

Description:

Returns the details of a CDN Zone

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType'
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).* Optional
cdnDetailsAn associative array of arbitrary keys and values.* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
friendlyPlanTagA string of text, containing no newlines or other control characters.* Optional
idA valid id number (a positive integer).
isFullZoneA boolean value (0 or 1).* Optional
nameA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
plan_tagA single word, consisting of only letters, digits, and underscores.* Optional
service_detailsAn associative array containing the fields:* Optional
 
checked_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time at which the site was last monitored at CloudFlare

created_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time and date at which the website was added to CloudFlare

development_mode

An integer value.

Whether or not the website is in development mode at CloudFlare

host

An associative array containing the fields:

The name and website of the place in which the website is physically hosted

 
nameOne or more words, consisting of only letters, digits, underscores, and one white space in between them.
websiteEither: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
id

A single word, consisting of only letters and digits.

The CloudFlare identifier for this website

meta

An associative array containing the fields:

Various metadata about the website, including options and settings

* Optional
 
custom_certificate_quotaA positive integer value (i.e. 1 and up).
multiple_railguns_allowedA boolean value (0 or 1).
page_rule_quotaA positive integer value (i.e. 1 and up).
phishing_detectedA boolean value (0 or 1).
stepA positive integer value (i.e. 1 and up).
wildcard_proxiableA boolean value (0 or 1).
modified_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

Time and date at which the website was last modified on CloudFlare

name

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The domain name of the website

name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The nameservers where the DNS for the domain is hosted

original_dnshost

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original provider of DNS for the domain

original_name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original nameservers that hosted the domain

* Optional
original_registrar

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The registrar that the domain was originally registered at

* Optional
owner

An associative array containing the fields:

Information about the CloudFlare user that owns this website

* Optional
 
emailA valid email address.
idA single word, consisting of only letters and digits.
typeA single word, consisting of only letters and digits.
paused

A boolean value (0 or 1).

Whether or not the site is paused at CloudFlare

permissions

An array of a permission string for a CloudFlare Site permission

The CloudFlare permissions available to the website

plan

An associative array containing the fields:

Information about the CloudFlare plan that the website is on

 
can_subscribeA boolean value (0 or 1).* Optional
currencyA single word, consisting of only letters and digits.
externally_managedA boolean value (0 or 1).
frequencyA single word, consisting of only letters and digits.
idA string.
is_subscribedA boolean value (0 or 1).
legacy_idA single word, consisting of only letters and digits.
nameA string of text, containing no newlines or other control characters.
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
status

One of: 'active', 'deactivated', 'deleted', 'initializing', 'moved', 'pending'

The CloudFlare status of the website (active, pending, initializing, moved, deleted, deactivated)

type

One of: 'full', 'partial'

What type of setup was used at CloudFlare to add the domain (full or partial)

subdomainsA string of text, containing no newlines or other control characters.* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

developmentMode

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/developmentMode

Description:

Parameters:

ParameterTypeNotes
enabledA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
dataAn associative array containing the fields:
 
service_detailsAn associative array containing the fields:
 
development_modeAn integer value.
enabledA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

dnsRecord

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/dnsRecord

Description:

Parameters:

ParameterTypeNotes
dnsRecordIDA string of text, containing no newlines or other control characters.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
dns_recordAn associative array of arbitrary keys and values.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

dnsRecordCreate

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/dnsRecordCreate

Description:

Parameters:

ParameterTypeNotes
contentA string of text, containing no newlines or other control characters.* Required
nameA string.* Required
ttlA non-negative integer value (i.e. 0 and up).
typeA string.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
dns_recordAn associative array of arbitrary keys and values.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

dnsRecordDelete

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/dnsRecordDelete

Description:

Parameters:

ParameterTypeNotes
dnsRecordIDA string of text, containing no newlines or other control characters.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
idA string of text, containing no newlines or other control characters.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

dnsRecordSearch

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/dnsRecordSearch

Description:

Parameters:

ParameterTypeNotes
contentA string of text, containing no newlines or other control characters.
nameA string.
typeA string.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
dataAn associative array containing the fields:
 
dns_recordsAn array of arbitrary values.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/list

Description:

List the existing CDN Zones

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType'
cdn_user_idA positive integer value (i.e. 1 and up).
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
activeA boolean value (0 or 1).* Optional
cdnDetailsAn associative array of arbitrary keys and values.* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
friendlyPlanTagA string of text, containing no newlines or other control characters.* Optional
idA valid id number (a positive integer).
isFullZoneA boolean value (0 or 1).* Optional
nameA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
plan_tagA single word, consisting of only letters, digits, and underscores.* Optional
service_detailsAn associative array containing the fields:* Optional
 
checked_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time at which the site was last monitored at CloudFlare

created_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time and date at which the website was added to CloudFlare

development_mode

An integer value.

Whether or not the website is in development mode at CloudFlare

host

An associative array containing the fields:

The name and website of the place in which the website is physically hosted

 
nameOne or more words, consisting of only letters, digits, underscores, and one white space in between them.
websiteEither: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
id

A single word, consisting of only letters and digits.

The CloudFlare identifier for this website

meta

An associative array containing the fields:

Various metadata about the website, including options and settings

* Optional
 
custom_certificate_quotaA positive integer value (i.e. 1 and up).
multiple_railguns_allowedA boolean value (0 or 1).
page_rule_quotaA positive integer value (i.e. 1 and up).
phishing_detectedA boolean value (0 or 1).
stepA positive integer value (i.e. 1 and up).
wildcard_proxiableA boolean value (0 or 1).
modified_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

Time and date at which the website was last modified on CloudFlare

name

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The domain name of the website

name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The nameservers where the DNS for the domain is hosted

original_dnshost

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original provider of DNS for the domain

original_name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original nameservers that hosted the domain

* Optional
original_registrar

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The registrar that the domain was originally registered at

* Optional
owner

An associative array containing the fields:

Information about the CloudFlare user that owns this website

* Optional
 
emailA valid email address.
idA single word, consisting of only letters and digits.
typeA single word, consisting of only letters and digits.
paused

A boolean value (0 or 1).

Whether or not the site is paused at CloudFlare

permissions

An array of a permission string for a CloudFlare Site permission

The CloudFlare permissions available to the website

plan

An associative array containing the fields:

Information about the CloudFlare plan that the website is on

 
can_subscribeA boolean value (0 or 1).* Optional
currencyA single word, consisting of only letters and digits.
externally_managedA boolean value (0 or 1).
frequencyA single word, consisting of only letters and digits.
idA string.
is_subscribedA boolean value (0 or 1).
legacy_idA single word, consisting of only letters and digits.
nameA string of text, containing no newlines or other control characters.
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
status

One of: 'active', 'deactivated', 'deleted', 'initializing', 'moved', 'pending'

The CloudFlare status of the website (active, pending, initializing, moved, deleted, deactivated)

type

One of: 'full', 'partial'

What type of setup was used at CloudFlare to add the domain (full or partial)

subdomainsA string of text, containing no newlines or other control characters.* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

pauseCloudFlare

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/pauseCloudFlare

Description:

Parameters:

ParameterTypeNotes
pausedA boolean value (0 or 1).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
dataAn associative array containing the fields:
 
service_detailsAn associative array containing the fields:
 
pausedA boolean value (0 or 1).
successA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

purgeCache

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/purgeCache

Description:

Parameters:

ParameterTypeNotes
filesAn array of a string of text, containing no newlines or other control characters.
purge_everythingA boolean value (0 or 1).* Optional
  • Defaults to: 0
tagsAn array of a single word, consisting of only letters, digits, and underscores.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

remoteList

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/remoteList

Description:

List all the zones via the CloudFlare API

Parameters:

ParameterTypeNotes
cdn_user_idA positive integer value (i.e. 1 and up).
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
checked_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time at which the site was last monitored at CloudFlare

created_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time and date at which the website was added to CloudFlare

development_mode

An integer value.

Whether or not the website is in development mode at CloudFlare

host

An associative array containing the fields:

The name and website of the place in which the website is physically hosted

 
nameOne or more words, consisting of only letters, digits, underscores, and one white space in between them.
websiteEither: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
id

A single word, consisting of only letters and digits.

The CloudFlare identifier for this website

meta

An associative array containing the fields:

Various metadata about the website, including options and settings

* Optional
 
custom_certificate_quotaA positive integer value (i.e. 1 and up).
multiple_railguns_allowedA boolean value (0 or 1).
page_rule_quotaA positive integer value (i.e. 1 and up).
phishing_detectedA boolean value (0 or 1).
stepA positive integer value (i.e. 1 and up).
wildcard_proxiableA boolean value (0 or 1).
modified_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

Time and date at which the website was last modified on CloudFlare

name

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The domain name of the website

name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The nameservers where the DNS for the domain is hosted

original_dnshost

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original provider of DNS for the domain

original_name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original nameservers that hosted the domain

* Optional
original_registrar

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The registrar that the domain was originally registered at

* Optional
owner

An associative array containing the fields:

Information about the CloudFlare user that owns this website

* Optional
 
emailA valid email address.
idA single word, consisting of only letters and digits.
typeA single word, consisting of only letters and digits.
paused

A boolean value (0 or 1).

Whether or not the site is paused at CloudFlare

permissions

An array of a permission string for a CloudFlare Site permission

The CloudFlare permissions available to the website

plan

An associative array containing the fields:

Information about the CloudFlare plan that the website is on

 
can_subscribeA boolean value (0 or 1).* Optional
currencyA single word, consisting of only letters and digits.
externally_managedA boolean value (0 or 1).
frequencyA single word, consisting of only letters and digits.
idA string.
is_subscribedA boolean value (0 or 1).
legacy_idA single word, consisting of only letters and digits.
nameA string of text, containing no newlines or other control characters.
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
status

One of: 'active', 'deactivated', 'deleted', 'initializing', 'moved', 'pending'

The CloudFlare status of the website (active, pending, initializing, moved, deleted, deactivated)

type

One of: 'full', 'partial'

What type of setup was used at CloudFlare to add the domain (full or partial)

page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

setting

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/setting

Description:

Parameters:

ParameterTypeNotes
settingA single word, consisting of only letters, digits, hyphens, and underscores.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required
valueEither: a string of text, containing no newlines or other control characters.; or an array of arbitrary values.; or an associative array of arbitrary keys and values.

Returns:

FieldType
settingAn associative array containing the fields:
 
editableA boolean value (0 or 1).
idA single word, consisting of only letters, digits, hyphens, and underscores.
modified_onAn ISO8601 extended format date and time: 2013-09-29T10:40Z.
valueEither: a string.; or an associative array of arbitrary keys and values.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

settings

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/settings

Description:

Parameters:

ParameterTypeNotes
itemsAn array of associative arrays containing
 
idA single word, consisting of only letters, digits, hyphens, and underscores.* Required
valueA string of text, containing no newlines or other control characters.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
dataAn associative array containing the fields:
 
settingsAn array of associative arrays containing
 
editableA boolean value (0 or 1).
idA single word, consisting of only letters, digits, hyphens, and underscores.
modified_onAn ISO8601 extended format date and time: 2013-09-29T10:40Z.
valueEither: a string.; or an associative array of arbitrary keys and values.
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.liquidweb.com/bleed/Network/CDN/Zone/update

Description:

Update a CDN zone

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType'
plan_tagA single word, consisting of only letters, digits, and underscores.
subdomainsA comma separated string of subdomains used in CloudFlare partial setup. The subdomains can be (but don't have to be) separated by a ':' to specify where the subdomain redirects to instead of the default.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
activeA boolean value (0 or 1).* Optional
cdnDetailsAn associative array of arbitrary keys and values.* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
friendlyPlanTagA string of text, containing no newlines or other control characters.* Optional
idA valid id number (a positive integer).
isFullZoneA boolean value (0 or 1).* Optional
nameA valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters)
plan_tagA single word, consisting of only letters, digits, and underscores.* Optional
service_detailsAn associative array containing the fields:* Optional
 
checked_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time at which the site was last monitored at CloudFlare

created_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

The time and date at which the website was added to CloudFlare

development_mode

An integer value.

Whether or not the website is in development mode at CloudFlare

host

An associative array containing the fields:

The name and website of the place in which the website is physically hosted

 
nameOne or more words, consisting of only letters, digits, underscores, and one white space in between them.
websiteEither: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
id

A single word, consisting of only letters and digits.

The CloudFlare identifier for this website

meta

An associative array containing the fields:

Various metadata about the website, including options and settings

* Optional
 
custom_certificate_quotaA positive integer value (i.e. 1 and up).
multiple_railguns_allowedA boolean value (0 or 1).
page_rule_quotaA positive integer value (i.e. 1 and up).
phishing_detectedA boolean value (0 or 1).
stepA positive integer value (i.e. 1 and up).
wildcard_proxiableA boolean value (0 or 1).
modified_on

An ISO8601 extended format date and time: 2013-09-29T10:40Z.

Time and date at which the website was last modified on CloudFlare

name

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The domain name of the website

name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The nameservers where the DNS for the domain is hosted

original_dnshost

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original provider of DNS for the domain

original_name_servers

An array of a valid http or https uri (i.e. http://www.liquidweb.com). or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The original nameservers that hosted the domain

* Optional
original_registrar

Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)

The registrar that the domain was originally registered at

* Optional
owner

An associative array containing the fields:

Information about the CloudFlare user that owns this website

* Optional
 
emailA valid email address.
idA single word, consisting of only letters and digits.
typeA single word, consisting of only letters and digits.
paused

A boolean value (0 or 1).

Whether or not the site is paused at CloudFlare

permissions

An array of a permission string for a CloudFlare Site permission

The CloudFlare permissions available to the website

plan

An associative array containing the fields:

Information about the CloudFlare plan that the website is on

 
can_subscribeA boolean value (0 or 1).* Optional
currencyA single word, consisting of only letters and digits.
externally_managedA boolean value (0 or 1).
frequencyA single word, consisting of only letters and digits.
idA string.
is_subscribedA boolean value (0 or 1).
legacy_idA single word, consisting of only letters and digits.
nameA string of text, containing no newlines or other control characters.
priceA positive floating-point value representing a price, containing 2 to 5 decimals.
status

One of: 'active', 'deactivated', 'deleted', 'initializing', 'moved', 'pending'

The CloudFlare status of the website (active, pending, initializing, moved, deleted, deactivated)

type

One of: 'full', 'partial'

What type of setup was used at CloudFlare to add the domain (full or partial)

subdomainsA string of text, containing no newlines or other control characters.* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
updated_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types