Overview
Error Handling

Methods

API Documentation (API Version bleed)

OneTimeSecret/

Description

Methods for working with OneTimeSecrets

create

URL:

https://api.liquidweb.com/bleed/OneTimeSecret/create

Description:

Creates a one time secret

Parameters:

ParameterTypeNotes
duration

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

Desired duration of time before the secret expires (in seconds).

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

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
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 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/OneTimeSecret/list

Description:

Returns details for all active secrets for a given accnt

Parameters:

ParameterTypeNotes
alsowithAn array of The value: 'secretLogs'
expiredA 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

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.
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 positive integer value (i.e. 1 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

read

URL:

https://api.liquidweb.com/bleed/OneTimeSecret/read

Description:

Returns the decoded secret, which results in the secret being 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