Overview
Error Handling

Methods

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:

ParameterTypeNotes
descriptionA string of text, containing no newlines or other control characters.
domain

One of the following:

The domain of a subaccount to associate with the secure datashare

 
A string permitting tabs, carriage returns and newlines
An array of a string permitting tabs, carriage returns and newlines
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.

expirationA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
secretA string permitting tabs, carriage returns and newlines* Required
ticket

One of the following:

The ticket number or ticket ID to associate with the secure datashare

 
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.
An array of 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.
uniq_id

One of the following:

The uniq_id of a subaccount to associate with the secure datashare

 
A six-character identifier, containing only capital letters and digits.
An array of a six-character identifier, containing only capital letters and digits.
views

An integer value.

Total number of times the secure datashare can be viewed. A negative number indicates it can be viewed an infinite number of times

* Optional
  • Defaults to: 1

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
activeA boolean value (0 or 1).
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
expiredA boolean value (0 or 1).
idA valid id number (a positive integer).
labelA string of text, containing no newlines or other control characters.
max_viewsAn integer value.
remaining_viewsAn integer value.
view_countA 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:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

link

URL:

https://api.liquidweb.com/bleed/SecureDatashare/link

Description:

Link a secure datashare with another object

Parameters:

ParameterTypeNotes
domain

One of the following:

The domain of a subaccount to link to the secure datashare

 
A string permitting tabs, carriage returns and newlines
An array of a string permitting tabs, carriage returns and newlines
id

A positive integer value (i.e. 1 and up).

The ID of the secure datashare

* Required
ticket

One of the following:

The ticket number or ticket ID to link to the secure datashare

 
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.
An array of 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.
uniq_id

One of the following:

The uniq_id of a subaccount to link to the secure datashare

 
A six-character identifier, containing only capital letters and digits.
An array of a six-character identifier, containing only capital letters and digits.

Returns:

FieldType
successA 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:

ParameterTypeNotes
alsowithAn array of One of: 'added_date', 'caseIDs', 'creator_ip', 'creator_username', 'description', 'removed_date', 'secretLogs', 'ticketNumbers', 'uniqIds', 'viewCount'
case_idA valid identifier for a Salesforce Case
expiredEither: a boolean value (0 or 1).; or An array of a boolean value (0 or 1).
order_byAn associative array containing the fields:
 
fieldOne of: 'accnt', 'id', 'label'* Optional
  • Defaults to: id
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
uniq_idEither: a six-character identifier, containing only capital letters and digits.; or An array of a six-character identifier, containing only capital letters and digits.

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
accntA valid account number, up to 6 digits in length.
activeA boolean value (0 or 1).
expirationA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
expiredA boolean value (0 or 1).
idA positive integer value (i.e. 1 and up).
labelA string of text, containing no newlines or other control characters.
max_viewsAn integer value.
remaining_viewsAn integer value.
view_countA non-negative integer value (i.e. 0 and up).
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

logs

URL:

https://api.liquidweb.com/bleed/SecureDatashare/logs

Description:

Return logs related to a secure datashare

Parameters:

ParameterTypeNotes
id

A positive integer value (i.e. 1 and up).

The ID of the secure datashare

* Required
order_byAn associative array containing the fields:
 
fieldOne of: 'date', 'id', 'type', 'username'* Optional
  • Defaults to: id
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
typeOne of the following:
 
One of: 'add', 'edit', 'remove', 'view'
An array of One of: 'add', 'edit', 'remove', 'view'

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
dateEither: a valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.; or a valid SQL time command, e.g. now()
idA positive integer value (i.e. 1 and up).
ipA valid IP address (v4 or v6)
messageA string permitting tabs, carriage returns and newlines
one_time_secret_idA positive integer value (i.e. 1 and up).
typeOne of: 'add', 'edit', 'remove', 'view'
usernameA username, containing letters, numbers, underscores, and hyphens, a period, up to 20 characters in length.
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA 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:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
secretA string permitting tabs, carriage returns and newlines

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

unlink

URL:

https://api.liquidweb.com/bleed/SecureDatashare/unlink

Description:

Unlink a secure datashare from another object

Parameters:

ParameterTypeNotes
domain

One of the following:

The domain of a subaccount to unlink to the secure datashare

 
A string permitting tabs, carriage returns and newlines
An array of a string permitting tabs, carriage returns and newlines
id

A positive integer value (i.e. 1 and up).

The ID of the secure datashare

* Required
ticket

One of the following:

The ticket number or ticket ID to unlink from the secure datashare

 
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.
An array of 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.
uniq_id

One of the following:

The uniq_id of a subaccount to unlink to the secure datashare

 
A six-character identifier, containing only capital letters and digits.
An array of a six-character identifier, containing only capital letters and digits.

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types