SquirrelSave Methods

API for Squirrelsave

squirrelsave.info()

Describes the SquirrelSave returning a dictionary.

Parameters:name (String) – Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
Returns:A dictionary with the following keys:
name
String: name of this SquirrelSave (same as service name), e.g. “testaa1”.
disk_gb
Float: GB of disk space the user can use (0 for unlimited)
disk_used_gb
Float: GB of disk space the user is using
disk_used_total_gb
Float: GB of disk space the user is using including historicals
last_update
Date: last time a backup was initiated

The keys as described in service.info() will also be returned.

Raises :ApiErrorDoesNotExist if the name is incorrect or it is in another account.
squirrelsave.keys()

Returns the ssh public and private keys for the account

Parameters:name (String) – Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
Returns:A dictionary with the following keys:
ssh_public_key
String: ssh public key
ssh_private_key
String: ssh private key
ssh_private_key_ppk
String: ssh private key in PPK format for Putty/WinScp
Raises :ApiErrorDoesNotExist if the name is incorrect or it is in another account.
squirrelsave.list()

List all the SquirrelSaves for an account.

Returns:Returns a list of dictionaries where each dictionary is as described in squirrelsave.info().

Previous topic

Service Methods

Next topic

vLAN API Methods

This Page