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/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)
SecureDatashare/
Description
Methods for working with secure datashares
create
URL:
https://api.liquidweb.com/bleed/SecureDatashare/create
Description:
Creates a secure datashare
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| description | A string of text, containing no newlines or other control characters. | |
| duration | A positive integer value (i.e. 1 and up). Desired duration of time before the secure datashare expires (in seconds). Ignored if the "expiration" field is populated. | |
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. | |
| secret | A string permitting tabs, carriage returns and newlines | * Required |
| ticket | Either: a valid identifier for a Salesforce Case; or a positive integer value (i.e. 1 and up).; or a positive integer value (i.e. 1 and up), potentially with leading zeros. | |
| views | A positive integer value (i.e. 1 and up). Total number of times the secure datashare can be viewed | * Optional
|
Returns:
| Field | Type |
|---|---|
| accnt | A valid account number, up to 6 digits in length. |
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. |
| expired | A boolean value (0 or 1). |
| id | A valid id number (a positive integer). |
| label | A string of text, containing no newlines or other control characters. |
| remaining_views | A positive integer value (i.e. 1 and up). |
| view_count | A non-negative integer value (i.e. 0 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
expire
URL:
https://api.liquidweb.com/bleed/SecureDatashare/expire
Description:
Marks the secret as expired and removes its contents from the database
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required |
Returns:
| Field | Type |
|---|---|
| success | 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/SecureDatashare/list
Description:
Returns details for all secure datashares for a given account
Parameters:
| Parameter | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| alsowith | An array of One of: 'added_date', 'caseIDs', 'creator_ip', 'description', 'removed_date', 'secretLogs', 'ticketNumbers', 'viewCount' | |||||||
| case_id | A valid identifier for a Salesforce Case | |||||||
| expired | A boolean value (0 or 1). | |||||||
| 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
read
URL:
https://api.liquidweb.com/bleed/SecureDatashare/read
Description:
Returns the decoded secret. If the secure datashare has been viewed the maximum amount of times, the secret will also be removed from the DB.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| id | A positive integer value (i.e. 1 and up). | * Required |
Returns:
| Field | Type |
|---|---|
| secret | A string permitting tabs, carriage returns and newlines |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
