Global

Type Definitions

CerberusClientOptions

Options for creating a CerberusClient

Type:

object

Properties:

Name	Type	Argument	Description
`hostUrl`	string		required base url for the Cerberus API.
`region`	string	<optional>	region to sign sts auth request for, defaults to us-west-2
`token`	string	<optional>	Override the cerberus token. Useful for testing
`debug`	boolean	<optional>	If set to true additional logging occurs.

Source:

index.js, line 17

ListFileResult

Type:

object

Properties:

Name	Type	Description
`has_next`	boolean	If the result requires pagination
`next_offset`	string	The offset to use for the next page
`limit`	number	The limit that was used for the results
`offset`	number	The offset of the results
`file_count_in_result`	number	Number of files in result
`total_file_count`	number	Number of total files under path
`secure_file_summaries`	array.<SecureFileSummary>

Source:

index.js, line 35

ListKeyResult

Type:

object

Properties:

Name	Type	Description
`keys`	array.<string>

Source:

index.js, line 28

SecureFileSummary

Type:

object

Properties:

Name	Type	Description
`sdbox_id`	string	The SDB id
`path`	string	The path for the file
`size_in_bytes`	number	The size in bytes of the file
`name`	string	The name of the file
`created_by`	string	Who originally uploaded the file
`created_ts`	string	ISO 8061 String of when the file was originally uploaded
`last_updated_by`	string	Who last updated the file
`last_updated_ts`	string	ISO 8061 String of when the file was last updated

Source:

index.js, line 48