hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
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:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType' | |
| cdn_user_id | A positive integer value (i.e. 1 and up). | |
| is_full_setup | A boolean value (0 or 1). | * Optional
|
| name | A valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters) | * Required |
| subdomains | A 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:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| active | A boolean value (0 or 1). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cdnDetails | An associative array of arbitrary keys and values. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| friendlyPlanTag | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isFullZone | A boolean value (0 or 1). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | A valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_tag | A single word, consisting of only letters, digits, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service_details | An associative array containing the fields: | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subdomains | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| updated_date | A 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
create
URL:
https://api.liquidweb.com/bleed/Network/CDN/Zone/create
Description:
Creates a new CDN Zone
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType' | |
| plan_tag | A single word, consisting of only letters, digits, and underscores. | * Required |
| type | A valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long. | * Optional
|
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| active | A boolean value (0 or 1). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cdnDetails | An associative array of arbitrary keys and values. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| friendlyPlanTag | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isFullZone | A boolean value (0 or 1). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | A valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_tag | A single word, consisting of only letters, digits, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service_details | An associative array containing the fields: | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subdomains | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| updated_date | A 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:
| Parameter | Type | Notes |
|---|---|---|
| force | A boolean value (0 or 1). | * Optional
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| deleted | A 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:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType' | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| active | A boolean value (0 or 1). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cdnDetails | An associative array of arbitrary keys and values. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| friendlyPlanTag | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isFullZone | A boolean value (0 or 1). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | A valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_tag | A single word, consisting of only letters, digits, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service_details | An associative array containing the fields: | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subdomains | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| updated_date | A 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:
| Parameter | Type | Notes |
|---|---|---|
| enabled | A boolean value (0 or 1). | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| data | An associative array containing the fields: | ||||||||
| |||||||||
| enabled | A boolean value (0 or 1). | ||||||||
| uniq_id | A 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:
| Parameter | Type | Notes |
|---|---|---|
| dnsRecordID | A string of text, containing no newlines or other control characters. | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| dns_record | An associative array of arbitrary keys and values. |
| uniq_id | A 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:
| Parameter | Type | Notes |
|---|---|---|
| content | A string of text, containing no newlines or other control characters. | * Required |
| name | A string. | * Required |
| ttl | A non-negative integer value (i.e. 0 and up). | |
| type | A string. | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| dns_record | An associative array of arbitrary keys and values. |
| uniq_id | A 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:
| Parameter | Type | Notes |
|---|---|---|
| dnsRecordID | A string of text, containing no newlines or other control characters. | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| id | A string of text, containing no newlines or other control characters. |
| uniq_id | A 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:
| Parameter | Type | Notes |
|---|---|---|
| content | A string of text, containing no newlines or other control characters. | |
| name | A string. | |
| type | A string. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | |||
|---|---|---|---|---|
| data | An associative array containing the fields: | |||
| ||||
| uniq_id | A 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:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType' | |
| cdn_user_id | A positive integer value (i.e. 1 and up). | |
| page_num | A positive integer value (i.e. 1 and up). | * Optional
|
| page_size | A positive integer value (i.e. 1 and up). | * Optional
|
Returns:
| Field | Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item_count | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| item_total | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| items | An array of associative arrays containing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_num | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_size | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_total | A 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:
| Parameter | Type | Notes |
|---|---|---|
| paused | A boolean value (0 or 1). | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| data | An associative array containing the fields: | ||||||||
| |||||||||
| success | A boolean value (0 or 1). | ||||||||
| uniq_id | A 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:
| Parameter | Type | Notes |
|---|---|---|
| files | An array of a string of text, containing no newlines or other control characters. | |
| purge_everything | A boolean value (0 or 1). | * Optional
|
| tags | An array of a single word, consisting of only letters, digits, and underscores. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| success | A boolean value (0 or 1). |
| uniq_id | A 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:
| Parameter | Type | Notes |
|---|---|---|
| cdn_user_id | A positive integer value (i.e. 1 and up). | |
| page_num | A positive integer value (i.e. 1 and up). | * Optional
|
| page_size | A positive integer value (i.e. 1 and up). | * Optional
|
Returns:
| Field | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item_count | A non-negative integer value (i.e. 0 and up). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| item_total | A non-negative integer value (i.e. 0 and up). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| items | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_num | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_size | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_total | A 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:
| Parameter | Type | Notes |
|---|---|---|
| setting | A single word, consisting of only letters, digits, hyphens, and underscores. | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
| value | Either: 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:
| Field | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| setting | An associative array containing the fields: | |||||||||
| ||||||||||
| uniq_id | A 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:
| Parameter | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| items | An array of associative arrays containing | |||||||
| ||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required | ||||||
Returns:
| Field | Type | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| data | An associative array containing the fields: | ||||||||||||||
| |||||||||||||||
| uniq_id | A 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:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of One of: 'cdnDetails', 'friendlyPlanTag', 'isFullZone', 'service_details', 'zoneType' | |
| plan_tag | A single word, consisting of only letters, digits, and underscores. | |
| subdomains | A 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_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| active | A boolean value (0 or 1). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cdnDetails | An associative array of arbitrary keys and values. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| friendlyPlanTag | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isFullZone | A boolean value (0 or 1). | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | A valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_tag | A single word, consisting of only letters, digits, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| service_details | An associative array containing the fields: | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| subdomains | A string of text, containing no newlines or other control characters. | * Optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| updated_date | A 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
