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)
SSL/Certificate/
DESCRIPTION
An SSL certificate allows for users to securely send information to a web service. In order for a certificate to be generally trusted, it needs to be signed by a trusted agent known as a certificate authority. The methods discussed in this document facilitate the process of ordering and managing certificates. The following directions will describe the process of ordering a new certificate via this API.
The first optional step is to call extractCSRDetails. It accepts a single argument of a CSR. This method will determine if the CSR is for a wildcard certificate, contact information in the CSR as well as if the 'auto' verification method is available for this certificate. Auto verification streamlines the verification process. This verification method is only available if the domain for which the CSR is made has DNS delegation to our name servers and if that domain's DNS zone is listed under your account.
Next, the order method should be called to start the order process. The return structure will have the details needed to call the verify method. For example, if you chose the metatag verification method, you would see a return structure like the following where html_meta_tag is the meta tag which must be inserted into the head of the root html document at one of the domains listed in the URLs array, and the uniq_id is the identifier for the CSR:
{
...
uniq_id => ssl_uniq_id,
verification_data => {
...
MetaTag => html_meta_tag,
URLs => [acceptable_domain, ...]
},
...
}
Once the order call returns, the verify method may be called for the new SSL order. This call requires the uniq_id of the CSR to be given (this would have been returned by the order method), and one of email, name, or URL depending on the desired verification method.
An extra step for email verification is to call confirmVerified which will refresh the cache on the SSL order details and return the new set of details including the certificate if email verification succeeded.
cancelOrder
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/cancelOrder
Description:
cancelOrder is a method used in the case you decide to cancel your certificate order.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type |
|---|---|
| cancelled | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
changeAutoRenew
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/changeAutoRenew
Description:
Enables or disables auto-renewal for the specified SSL certificate.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| auto_renew | One of: 'Off', 'On' | * Required |
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Optional | ||||||||||||||||||||||||
| autorenew_value | One of: 'Off', 'On' | * Optional | ||||||||||||||||||||||||
| certificate | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | |||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||
| duration | One of: '12', '24', '36' | |||||||||||||||||||||||||
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||
| notified | A boolean value (0 or 1). | |||||||||||||||||||||||||
| order_id | A single word, consisting of only letters and digits. | |||||||||||||||||||||||||
| renewable | A boolean value (0 or 1). | |||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||||||||||||||||||||
| verification_data | An associative array containing the fields: | |||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| verification_method | One of: 'auto', 'dns', 'email', 'metatag' | |||||||||||||||||||||||||
| verification_status | One of: 'Attempted', 'Delayed', 'Failed', 'Pending', 'Verified' | |||||||||||||||||||||||||
| verify_urls | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||
| wildcard | A boolean value (0 or 1). | |||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
changeVerificationMethod
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/changeVerificationMethod
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | |
| verification_method | One of: 'dns', 'metatag' | * Required |
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Optional | ||||||||||||||||||||||||
| autorenew_value | One of: 'Off', 'On' | * Optional | ||||||||||||||||||||||||
| certificate | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | |||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||
| duration | One of: '12', '24', '36' | |||||||||||||||||||||||||
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||
| notified | A boolean value (0 or 1). | |||||||||||||||||||||||||
| order_id | A single word, consisting of only letters and digits. | |||||||||||||||||||||||||
| renewable | A boolean value (0 or 1). | |||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||||||||||||||||||||
| verification_data | An associative array containing the fields: | |||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| verification_method | One of: 'auto', 'dns', 'email', 'metatag' | |||||||||||||||||||||||||
| verification_status | One of: 'Attempted', 'Delayed', 'Failed', 'Pending', 'Verified' | |||||||||||||||||||||||||
| verify_urls | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||
| wildcard | A boolean value (0 or 1). | |||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
confirmVerified
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/confirmVerified
Description:
Refreshes the certificate data cache in the case of email authentication.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Optional | ||||||||||||||||||||||||
| autorenew_value | One of: 'Off', 'On' | * Optional | ||||||||||||||||||||||||
| certificate | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | |||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||
| duration | One of: '12', '24', '36' | |||||||||||||||||||||||||
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||
| notified | A boolean value (0 or 1). | |||||||||||||||||||||||||
| order_id | A single word, consisting of only letters and digits. | |||||||||||||||||||||||||
| renewable | A boolean value (0 or 1). | |||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||||||||||||||||||||
| verification_data | An associative array containing the fields: | |||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| verification_method | One of: 'auto', 'dns', 'email', 'metatag' | |||||||||||||||||||||||||
| verification_status | One of: 'Attempted', 'Delayed', 'Failed', 'Pending', 'Verified' | |||||||||||||||||||||||||
| verify_urls | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||
| wildcard | A boolean value (0 or 1). | |||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/details
Description:
Retrieves the details of a particular SSL associated with the account.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | A single word, consisting of only letters, digits, and underscores. | |
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required if:
|
| subaccnt | A positive integer value (i.e. 1 and up). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required if:
|
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Optional | ||||||||||||||||||||||||
| autorenew_value | One of: 'Off', 'On' | * Optional | ||||||||||||||||||||||||
| certificate | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | |||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||
| duration | One of: '12', '24', '36' | |||||||||||||||||||||||||
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||
| notified | A boolean value (0 or 1). | |||||||||||||||||||||||||
| order_id | A single word, consisting of only letters and digits. | |||||||||||||||||||||||||
| renewable | A boolean value (0 or 1). | |||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||||||||||||||||||||
| verification_data | An associative array containing the fields: | |||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| verification_method | One of: 'auto', 'dns', 'email', 'metatag' | |||||||||||||||||||||||||
| verification_status | One of: 'Attempted', 'Delayed', 'Failed', 'Pending', 'Verified' | |||||||||||||||||||||||||
| verify_urls | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||
| wildcard | A boolean value (0 or 1). | |||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
extractCSRDetails
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/extractCSRDetails
Description:
This method examines a given CSR and checks to see if it is for a wildcard domain and if auto verification is a viable option.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | * Required |
Returns:
| Field | Type | Notes | ||||
|---|---|---|---|---|---|---|
| autoVerifyCapable | A boolean value (0 or 1). | |||||
| city | A string of text, containing no newlines or other control characters. | * Optional | ||||
| commonName | A string of text, containing no newlines or other control characters. | * Optional | ||||
| country | A string of text, containing no newlines or other control characters. | * Optional | ||||
| emailAddress | A string of text, containing no newlines or other control characters. | * Optional | ||||
| invalidFields | An array of associative arrays containing | * Optional | ||||
| ||||||
| organization | A string of text, containing no newlines or other control characters. | * Optional | ||||
| organizationalUnit | A string of text, containing no newlines or other control characters. | * Optional | ||||
| san | An array of a string of text, containing no newlines or other control characters. | * Optional | ||||
| state | A string of text, containing no newlines or other control characters. | * Optional | ||||
| wildcard | A boolean value (0 or 1). | |||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
generate
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/generate
Description:
The generate method is used to trgger generation of a new ssl certificate. This process is only valid if the given server uniq_id is a whm enabled server.
This process will take the provided information, and generate an ssl certificate on your server using the information. If the auto verification option is available, it will then proceed to carry out the verification process for the certificate, and then install it on your server.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| autorenew | A boolean value (0 or 1). | * Optional
|
| city | A valid city name. | * Required |
| commonName | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required |
| country | A valid ISO country code. | * Required |
| duration | One of: '1', '2', '3' | * Optional
|
| emailAddress | A valid email address. | * Required |
| keysize | One of: '1024', '2048', '4096', '512' | * Optional
|
| organization | A valid company name, up to 100 characters in length. | * Required |
| organizationalUnit | A valid name, up to 100 characters in length. | * Required |
| state | A valid state or province. | * Required |
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | |
| verification_method | One of: 'auto', 'dns', 'metatag' | * Required |
| wildcard | A boolean value (0 or 1). | * Optional
|
Returns:
| Field | Type |
|---|---|
| generating | A string of text, containing no newlines or other control characters. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
hostServers
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/hostServers
Description:
Returns a list of servers which are candidates for automatic SSL certificate generation and installation. Will return details on if the servers which are candidates support the needed functionality.
Parameters:
No Values Defined
Returns:
| Field | Type | Notes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| One or more keys matching: a valid hostname (Fully qualified domain name, consisting only of letters, digits and '-') | An associative array containing the fields: | * Optional | ||||||||
| ||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
limits
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/limits
Description:
This method returns a count of how many certificates have been ordered in the billing cycle and how many are allowed to be ordered (there is a limit if they are a reseller).
Parameters:
No Values Defined
Returns:
| Field | Type | Notes |
|---|---|---|
| current | A positive integer value (i.e. 1 and up). | |
| limit | A positive integer value (i.e. 1 and up). | * Optional |
| limit_reached | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/list
Description:
Lists the SSL orders associated with the account.
Parameters:
| Parameter | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| alsowith | A single word, consisting of only letters, digits, and underscores. | |||||||
| domain | A hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc) | |||||||
| 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
| ||||||
| renewable | A boolean value (0 or 1). | |||||||
| verification_method | One of: 'dns', 'email', 'metatag' | |||||||
| verification_status | One of: 'Attempted', 'Delayed', 'Failed', 'Pending', 'Verified' | |||||||
| wildcard | A boolean value (0 or 1). | |||||||
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
order
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/order
Description:
Begins the order process.
Note: auto verification involves adding a TXT record to the DNS zone which has authority over the domain specified in the CSR. In order for this option to be available, the domain's delegation must specify our DNS servers as having authority over it and the DNS zone must exist in your account.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| autorenew | A boolean value (0 or 1). | * Optional
|
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | * Required |
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a wildcard, represented by '*.domain'. | * Required |
| duration | One of: '1', '2', '3' | * Optional
|
| verification_method | One of: 'auto', 'dns', 'metatag' | * Required |
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Optional | ||||||||||||||||||||||||
| autorenew_value | One of: 'Off', 'On' | * Optional | ||||||||||||||||||||||||
| certificate | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | |||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||
| duration | One of: '12', '24', '36' | |||||||||||||||||||||||||
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||
| notified | A boolean value (0 or 1). | |||||||||||||||||||||||||
| order_id | A single word, consisting of only letters and digits. | |||||||||||||||||||||||||
| renewable | A boolean value (0 or 1). | |||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||||||||||||||||||||
| verification_data | An associative array containing the fields: | |||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| verification_method | One of: 'auto', 'dns', 'email', 'metatag' | |||||||||||||||||||||||||
| verification_status | One of: 'Attempted', 'Delayed', 'Failed', 'Pending', 'Verified' | |||||||||||||||||||||||||
| verify_urls | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||
| warning | A string of text, containing no newlines or other control characters. | * Optional | ||||||||||||||||||||||||
| wildcard | A boolean value (0 or 1). | |||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
renew
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/renew
Description:
Renew allows for renewing a certificate for a certain period of time. Calling this method will require an iteration of the verification process again.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| duration | One of: '1', '2', '3' | * Optional
|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Optional | ||||||||||||||||||||||||
| autorenew_value | One of: 'Off', 'On' | * Optional | ||||||||||||||||||||||||
| certificate | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | |||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||
| duration | One of: '12', '24', '36' | |||||||||||||||||||||||||
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||
| notified | A boolean value (0 or 1). | |||||||||||||||||||||||||
| order_id | A single word, consisting of only letters and digits. | |||||||||||||||||||||||||
| renewable | A boolean value (0 or 1). | |||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||||||||||||||||||||
| verification_data | An associative array containing the fields: | |||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| verification_method | One of: 'auto', 'dns', 'email', 'metatag' | |||||||||||||||||||||||||
| verification_status | One of: 'Attempted', 'Delayed', 'Failed', 'Pending', 'Verified' | |||||||||||||||||||||||||
| verify_urls | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||
| wildcard | A boolean value (0 or 1). | |||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
revoke
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/revoke
Description:
THIS METHOD IS DEPRECATED. Our SSL provider (Global Sign) removed this functionality from their API. Currently it will always result in an exception.
Revoke is a method used in the case of an SSL certificate being compromised. Once the certificate has been revoked, it will no longer show as being a trusted certificate to the users of the web service which employs that certificate.
Once the certificate has been revoked, it is removed from the account.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type |
|---|---|
| revoked | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
verification
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/verification
Description:
Given a server that we will be generating a CSR on, and a domain that the certificate will be for, return the list of valid certificate verification methods.
This is accomplished primarily by identifying if the dns for the domain is hosted on LiquidWeb nameservers, or if the nameservers for the domain reside on the server we're generating the csr on to determine the validity of the automatic verification method.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required |
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type |
|---|---|
| verification_methods | An array of One of: 'auto', 'dns', 'metatag' |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
verify
URL:
https://api.liquidweb.com/bleed/SSL/Certificate/verify
Description:
Performs the verification check. Depending on the verification method specified in the order method, a particular argument will need to be given to the verify method.
Verification Method | argument | value =============================================================================== dns | name | One of the approved domains to check its DNS | | TXT record --------------------+----------+----------------------------------------------- metatag | url | URL to the root of one of the approved domains
Note: If the verification method was email, an additional call to confirmVerified is needed to refresh the data cache.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| name | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | |
| url | Either: a valid http or https uri (i.e. http://www.liquidweb.com).; or An array of a valid http or https uri (i.e. http://www.liquidweb.com). |
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Optional | ||||||||||||||||||||||||
| autorenew_value | One of: 'Off', 'On' | * Optional | ||||||||||||||||||||||||
| certificate | An associative array containing the fields: | * Optional | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| created | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| csr | An ssl certificate signing request, including the BEGIN CERTIFICATE REQUEST and END CERTIFICATE REQUEST comments. | |||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||
| duration | One of: '12', '24', '36' | |||||||||||||||||||||||||
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | * Optional | ||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||
| notified | A boolean value (0 or 1). | |||||||||||||||||||||||||
| order_id | A single word, consisting of only letters and digits. | |||||||||||||||||||||||||
| renewable | A boolean value (0 or 1). | |||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||||||||||||||||||||
| verification_data | An associative array containing the fields: | |||||||||||||||||||||||||
| ||||||||||||||||||||||||||
| verification_method | One of: 'auto', 'dns', 'email', 'metatag' | |||||||||||||||||||||||||
| verification_status | One of: 'Attempted', 'Delayed', 'Failed', 'Pending', 'Verified' | |||||||||||||||||||||||||
| verify_urls | An array of arbitrary values. | * Optional | ||||||||||||||||||||||||
| wildcard | A boolean value (0 or 1). | |||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
