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/DNS/Record/
DESCRIPTION
Each DNS zone contains multiple Resource Records, which are the guts of DNS. Each record can point an domain name to an IP, a subdomain to another domain, etc.
This section of the API allows interaction with all the various Resource Records in your zones.
create
URL:
https://api.liquidweb.com/bleed/Network/DNS/Record/create
Description:
This method is used to add new resource records (RRs) to a zone.
The returned data will be an associative array of the fields of the record, and will include any parsed rdata fields in that associateve array, such as the priority and exchange fields of an MX record.
In the v1 api, the prio field is considered seperate from rdata, and should be specified seperately, but in the bleed version and future numbered versions of the api, the prio field is considered part of the record data, and should be included there if appropriate for the record.
Fields: zone_id: The id of the zone that you are creating the record in. zone: The name of the zone that you are creating the record in. name: The name field of the record itself. type: The type of the record, which must a valid DNS record type. ttl: The Time To Live for the record. prio: The priority field for the record. This field applies to MX and SRV records. rdata: The Record Data associated with this DNS record. The exact contents are dependent on record type.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| name | A string permitting tabs, carriage returns and newlines | * Required |
| rdata | A string permitting tabs, carriage returns and newlines | * Required |
| ttl | A positive integer value (i.e. 1 and up). | |
| type | A valid DNS resource record type | * Required |
| zone | Either: a valid forward DNS Zone name.; or a valid reverse DNS zone. | * Required if:
|
| zone_id | A positive integer value (i.e. 1 and up). | * Required if:
|
Returns:
| Field | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| adminEmail | Either: a valid email address.; or a valid admin email for an SOA record. | * Optional | ||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||
| exchange | A valid hostname (Fully qualified domain name, consisting only of letters, digits and '-') | * Optional | ||||||
| expiry | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| fullData | A string. | * Optional | ||||||
| id | A positive integer value (i.e. 1 and up). | |||||||
| last_updated | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||
| minimum | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| name | Either: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'. | |||||||
| nameserver | Either: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record. | * Optional | ||||||
| port | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| prio | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| rdata | A string. | |||||||
| refreshInterval | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| regionOverrides | An array of associative arrays containing | * Optional | ||||||
| ||||||||
| retry | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| serial | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| target | A valid hostname (Fully qualified domain name, consisting only of letters, digits and '-') | * Optional | ||||||
| ttl | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| type | One of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT' | |||||||
| weight | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| zone_id | A positive integer value (i.e. 1 and up). | |||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
delete
URL:
https://api.liquidweb.com/bleed/Network/DNS/Record/delete
Description:
This method is used to delete resource records (RRs) from a zone file It returns the 'deleted' field, whose value is the records id field.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required |
Returns:
| Field | Type |
|---|---|
| deleted | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Network/DNS/Record/details
Description:
Retrieve details about a particular resource record.
The returned structure is an associative array of the details of the record, with additional fields added to represent the derived meaning of the rdata field.
For example, an MX record will have a field present for the exchange that it points to, and an SRV record will have fields for weight, port and target.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required |
Returns:
| Field | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| adminEmail | Either: a valid email address.; or a valid admin email for an SOA record. | * Optional | ||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||
| exchange | A valid hostname (Fully qualified domain name, consisting only of letters, digits and '-') | * Optional | ||||||
| expiry | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| fullData | A string. | * Optional | ||||||
| id | A positive integer value (i.e. 1 and up). | |||||||
| last_updated | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||
| minimum | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| name | Either: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'. | |||||||
| nameserver | Either: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record. | * Optional | ||||||
| port | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| prio | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| rdata | A string. | |||||||
| refreshInterval | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| regionOverrides | An array of associative arrays containing | * Optional | ||||||
| ||||||||
| retry | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| serial | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| target | A valid hostname (Fully qualified domain name, consisting only of letters, digits and '-') | * Optional | ||||||
| ttl | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| type | One of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT' | |||||||
| weight | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| zone_id | A positive integer value (i.e. 1 and up). | |||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/Network/DNS/Record/list
Description:
This method is used to get resource records (RRs) from a zone file. Each entry in the 'items' array referrs to one of the records in the zone. The details of these entries are further described in the 'details' method.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| page_num | A positive integer value (i.e. 1 and up). | * Optional
|
| page_size | A positive integer value (i.e. 1 and up). | * Optional
|
| zone | Either: a valid forward DNS Zone name.; or a valid reverse DNS zone. | * Required if:
|
| zone_id | A positive integer value (i.e. 1 and up). | * Required if:
|
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 an associative array containing a DNS Resource Records details |
| 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
multiCreateAndUpdate
URL:
https://api.liquidweb.com/bleed/Network/DNS/Record/multiCreateAndUpdate
Description:
This method is used to create and update multiple resource records (RRs) simultaneously.
Parameters:
| Parameter | Type | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| records | An array of associative arrays containing | * Required | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
Returns:
| Field | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| result | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
update
URL:
https://api.liquidweb.com/bleed/Network/DNS/Record/update
Description:
This method is used to update resource records (RRs) in a zone.
For details on the return structure, input field explanation, and interversion compatibility caveats, please referr to the documentation of the 'create' method.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required |
| name | A string permitting tabs, carriage returns and newlines | |
| rdata | A string permitting tabs, carriage returns and newlines | |
| ttl | A positive integer value (i.e. 1 and up). |
Returns:
| Field | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| adminEmail | Either: a valid email address.; or a valid admin email for an SOA record. | * Optional | ||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||
| exchange | A valid hostname (Fully qualified domain name, consisting only of letters, digits and '-') | * Optional | ||||||
| expiry | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| fullData | A string. | * Optional | ||||||
| id | A positive integer value (i.e. 1 and up). | |||||||
| last_updated | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||
| minimum | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| name | Either: a valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters); or a valid reverse ipv4 DNS record.; or a valid reverse ipv6 DNS record.; or a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a wildcard, represented by '*.domain'. | |||||||
| nameserver | Either: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-'); or a valid nameserver in an SOA record. | * Optional | ||||||
| port | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| prio | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| rdata | A string. | |||||||
| refreshInterval | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| regionOverrides | An array of associative arrays containing | * Optional | ||||||
| ||||||||
| retry | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| serial | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| target | A valid hostname (Fully qualified domain name, consisting only of letters, digits and '-') | * Optional | ||||||
| ttl | A positive integer value (i.e. 1 and up). | * Optional | ||||||
| type | One of: 'A', 'AAAA', 'ALIAS', 'CNAME', 'MX', 'NS', 'PTR', 'SOA', 'SRV', 'TXT' | |||||||
| weight | A non-negative integer value (i.e. 0 and up). | * Optional | ||||||
| zone_id | A positive integer value (i.e. 1 and up). | |||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
