pycpg 1.0.2

The Official CrashPlan Python API Client

Official CrashPlan Python SDK

pycpg is a Python wrapper around the CrashPlan REST APIs that also provides several other useful utility methods. It is designed to be used for developing your own tools for working with CrashPlan data while avoiding the overhead of session / authentication management.

Requirements

• Python 3.11+
• CrashPlan Cloud environment (e.g. console.us1.crashplan.com or console.us2.crashplan.com)

Installation

Run the setup.py script to install the pycpg package and its dependencies on your system. You will likely need administrative privileges for this.

$ python setup.py install

Hello, pycpg

Here's a simple example to verify the installation and your server/account.

Launch the Python interpreter

$ python

Import a couple essentials

>>> import pycpg.sdk
>>> import pycpg.util as util

Initialize the client.

>>> sdk = pycpg.sdk.from_local_account("https://console.us1.crashplan.com", "john.doe", "password")

or alternatively

>>> sdk = pycpg.sdk.from_jwt_provider("https://console.us1.crashplan.com", jwt_provider_function)

Get and print your user information.

>>> response = sdk.users.get_current()
>>> util.print_response(response)

You should see something like the following:

{
    "username": "john.doe",
    "orgName": "ACME Organization",
    "userId": 123456,
    "emailPromo": true,
    "licenses": [],
    "modificationDate": "2018-08-29T15:32:56.995-05:00",
    "blocked": false,
    "usernameIsAnEmail": true,
    "userUid": "1234567890abcdef",
    "userExtRef": null,
    "email": "[e-mail]",
    "status": "Active",
    "localAuthenticationOnly": false,
    "orgUid": "123456789123456789",
    "passwordReset": true,
    "active": true,
    "creationDate": "2012-01-16T11:25:43.545-06:00",
    "orgType": "BUSINESS",
    "firstName": "John",
    "lastName": "Doe",
    "notes": null,
    "orgId": 123456,
    "quotaInBytes": -1,
    "invited": false
}

Configuration

There are a few default settings that affect the behavior of the client.

Name	Description	Default
verify_ssl_certs	Controls whether the SDK verifies the server's certificate. Possible values: True, False, or a path to a CA bundle to use.	True
proxies	Dictionary mapping protocol or protocol and hostname to the URL of the proxy. See the Requests library's documentation on proxies for more info.	None
debug.level	Controls log level	logging.NOTSET
debug.logger	Controls logger used	logging.Logger with StreamHandler sending to sys.stderr
items_per_page	Controls how many items are retrieved per request for methods that loops over several "pages" of items in order to collect them all.	500

To override these settings, import pycpg.settings and override values as necessary before creating the client. For example, to disable certificate validation in a dev environment:

import pycpg.sdk
import pycpg.settings as settings
import logging

settings.verify_ssl_certs = False

# customize logging
custom_logger = logging.getLogger("my_app")
handler = logging.FileHandler("my_app.log")
custom_logger.addHandler(handler)
settings.debug.logger = custom_logger
settings.debug.level = logging.DEBUG

sdk = pycpg.sdk.from_local_account("https://console.us1.crashplan.com", "my_username", "my_password")

Usage

The SDK object opens availability to APIs across the CrashPlan environment, including storage nodes.

import pycpg.sdk

sdk = pycpg.sdk.from_local_account("https://console.us1.crashplan.com", "my_username", "my_password")

# clients are organized by feature groups and accessible under the sdk object

# get information about the current user.
current_user = sdk.users.get_current()

# page through all devices available to this user.
for device_page in sdk.devices.get_all():
    for device in device_page["computers"]:
        print(device)

# page through all orgs available to this user.
for org_page in sdk.orgs.get_all():
    for org in org_page["orgs"]:
        print(org)

# save a copy of a file from an archive this user has access to into the current working directory.
stream_response = sdk.archive.stream_from_backup("/full/path/to/file.txt", "1234567890")
with open("/path/to/my/file", 'wb') as f:
    for chunk in stream_response.iter_content(chunk_size=128):
        if chunk:
            f.write(chunk)

# search file events -- deprecated, to be replaced with another example
from pycpg.sdk.queries.fileevents.file_event_query import FileEventQuery
from pycpg.sdk.queries.fileevents.filters import *

query = FileEventQuery.all(MD5.eq("e804d1eb229298b04522c5504b8131f0"))
file_events = sdk.securitydata.search_file_events(query)

Additional Resources

For complete documentation on the CrashPlan web API that backs this SDK, here are some helpful resources:

• Introduction to the CrashPlan API
• CrashPlan API documentation viewers