Use the Python SDK

The clumio-python-sdk package wraps the Clumio REST API in an object-oriented client. Resources are exposed as properties on the client, and operations are invoked on the resource.

Install

pip install 'git+https://github.com/clumio-code/clumio-python-sdk.git@<version>#egg=clumioapi'

Requires Python 3.9 or later. The repository README documents installation from GitHub rather than PyPI.

Authenticate

from clumioapi import configuration, clumioapi_client

config = configuration.Configuration(
    api_token="<your_api_token>",
    hostname="us-west-2.api.clumio.com",
)

client = clumioapi_client.ClumioAPIClient(config=config)

hostname must match the control plane that issued the token. See Authentication.

Use it

Resources are available as properties. Operations are versioned, which is why the suffix appears in the accessor:

policy_defn = client.policy_definitions_v1.list_policy_definitions()

Common resources

Property	Covers
`client.policy_definitions_v1`	Create, list and update backup policy definitions
`client.protection_groups_v1`	Protection groups and their rules
`client.aws_connections_v1`	AWS account connections
`client.organizational_units_v1`	Organisational units
`client.restored_files_v1`	File-level restores
`client.users_v1`	Users and roles

List operations are paginated

Each resource has a <resource>_paginator property that follows the API’s _links.next chain. The standard controller returns one page and accepts limit and start when you need to manage paging directly.

Errors

API errors raise an exception carrying the HTTP status and API error body. Log both when diagnosing a failed request.

REST API reference

The endpoint-level reference behind every SDK method.

Source and issues

Read the code, report a bug, or open a pull request.

Overview

SDKs

Infrastructure as code

Automation examples

Use the Python SDK

Install

Authenticate

Use it

Next

REST API reference

Source and issues

​Install

​Authenticate

​Use it

​Next

REST API reference

Source and issues

Install

Authenticate

Use it

Next