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/Zone/
DESCRIPTION
DNS allows you to point domain names to IP addresses. Each domain name is represented by a DNS zone, which in turns can contain several records of varying types. For more information about the generals of DNS, refer to Wikipedia or some other resource.
This section of the API contains methods for creating and deleting zones from our DNS system, as well as getting information about what zones we are currently serving for you.
bulkUpdateTTL
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/bulkUpdateTTL
Description:
Update all resource records in a zone with the same TTL.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
| ttl | A positive integer value (i.e. 1 and up). | * Required |
Returns:
| Field | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| records | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
create
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/create
Description:
Add a new DNS zone.
Parameters:
| Parameter | Type | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| add_pbe_records | A boolean value (0 or 1). | |||||||||
| cloudsite | A boolean value (0 or 1). | |||||||||
| live_domain | A boolean value (0 or 1). | |||||||||
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required | ||||||||
| no_extra | A boolean value (0 or 1). | |||||||||
| region_support | A boolean value (0 or 1). | |||||||||
| zone_data | An associative array containing the fields: | |||||||||
| ||||||||||
Returns:
| Field | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| delegation | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional |
| delegation_checked | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| delegation_status | A string permitting tabs, carriage returns and newlines | * Optional |
| id | A positive integer value (i.e. 1 and up). | |
| master | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| notified_serial | A positive integer value (i.e. 1 and up). | * Optional |
| region_support | A boolean value (0 or 1). | * Optional |
| type | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
delegation
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/delegation
Description:
This method can be used to check if a DNS zone is properly delegated to our nameservers.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid domain name (max 127 labels, each between 1 and 63 characters, totaling no more than 253 characters) | * Required if:
|
Returns:
| Field | Type |
|---|---|
| delegation | A single word, consisting of only letters, digits, and underscores. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
delete
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/delete
Description:
Remove a DNS zone.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
Returns:
| Field | Type |
|---|---|
| deleted | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/details
Description:
Retrieve details on a particular zone served by our DNS servers.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | An array of The value: 'delegation' | |
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
Returns:
| Field | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| delegation | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional |
| delegation_checked | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| delegation_status | A string permitting tabs, carriage returns and newlines | * Optional |
| id | A positive integer value (i.e. 1 and up). | |
| master | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| notified_serial | A positive integer value (i.e. 1 and up). | * Optional |
| region_support | A boolean value (0 or 1). | * Optional |
| type | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
formatAsBind
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/formatAsBind
Description:
Formats the Zone and Records in BIND Format
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A valid id number (a positive integer). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
Returns:
| Field | Type |
|---|---|
| bind_data | A string permitting tabs, carriage returns and newlines |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
importCPanelZone
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/importCPanelZone
Description:
Given a domain and a uniq_id, imports domain information from cPanel and creates requisite records.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | A valid forward DNS Zone name. | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Required if:
|
| active | A boolean value (0 or 1). | |
| delegation | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional |
| delegation_checked | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| delegation_status | A string permitting tabs, carriage returns and newlines | * Optional |
| id | A positive integer value (i.e. 1 and up). | |
| master | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| notified_serial | A positive integer value (i.e. 1 and up). | * Optional |
| region_support | A boolean value (0 or 1). | * Optional |
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| type | A single word, consisting of only letters and digits. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
importZoneFile
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/importZoneFile
Description:
Upload a DNS zone file and add the zone.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| zonefile | A string permitting tabs, carriage returns and newlines | * Required |
Returns:
| Field | Type | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| zones | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/list
Description:
Retrieve a list of zones that are served by our DNS servers for your account.
Parameters:
| Parameter | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| delegation_status | One of: 'BAD_NAMESERVERS', 'CORRECT', 'NXDOMAIN', 'SERVFAIL', 'UNKNOWN' | |||||||
| domain | A fragment of a valid domain name, suitable for partial domain searching | |||||||
| order_by | An associative array containing the fields: | |||||||
| ||||||||
| 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
parkableIps
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/parkableIps
Description:
Returns a list of IPs that are valid destinations for A records to be created at the time of creating the zone.
Parameters:
No Values Defined
Returns:
| Field | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| items | An array of associative arrays containing | |||||||||
| ||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
replaceMXForPBE
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/replaceMXForPBE
Description:
Replaces MX records on a given zone with the appropriate MX Records for Premium Business Email (PBE)
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A valid id number (a positive integer). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
Returns:
| Field | Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| records | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
summary
URL:
https://api.liquidweb.com/bleed/Network/DNS/Zone/summary
Description:
Retrieve a summary on a particular DNS zone.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| name | A valid forward DNS Zone name. | * Required |
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| active | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| delegation | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| delegation_checked | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| delegation_status | A string permitting tabs, carriage returns and newlines | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| master | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| notified_serial | A positive integer value (i.e. 1 and up). | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| records | An associative array containing the fields: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| region_support | A boolean value (0 or 1). | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type | A single word, consisting of only 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/DNS/Zone/update
Description:
Update the zone features.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| DNSRegionSupport | A boolean value (0 or 1). | |
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| name | A valid forward DNS Zone name. | * Required if:
|
Returns:
| Field | Type | Notes |
|---|---|---|
| active | A boolean value (0 or 1). | |
| delegation | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional |
| delegation_checked | A valid date and time in YYYY-MM-DD HH:MM:SS format. | * Optional |
| delegation_status | A string permitting tabs, carriage returns and newlines | * Optional |
| id | A positive integer value (i.e. 1 and up). | |
| master | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| notified_serial | A positive integer value (i.e. 1 and up). | * Optional |
| region_support | A boolean value (0 or 1). | * Optional |
| type | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
