Skip to content

REST API

A versioned, JWT-authenticated REST surface over the Clumio platform – script protection, restore, discovery, and audit against your Clumio tenant from any HTTP-capable language. The starting point for wiring Clumio into automation that doesn’t go through the UI.

Prerequisite

Get an API token

Every request to the Clumio REST API needs a JWT bearer token. Generate a long-lived token from Administration → Access management → API tokens in the Clumio UI, then send it as Authorization: Bearer ${TOKEN} on every request. Tokens persist until you refresh or delete them.

DOCUMENTATION

What to read

The canonical API reference and an open-source sample you can crib from for your first script.

REFERENCE

Clumio REST API reference

Every endpoint with worked request and response examples, a machine-readable Discovery API that maps resources to operation IDs, per-resource versioning through the Accept header, and more. If you’re scripting against Clumio, start here.

SAMPLE

Example – Bulk restore

A Python project from the Clumio team that scripts large-scale restores against the REST API end-to-end – token-based auth, paginated discovery, restore submission, and polling. A working starting point for your own automation.

FULL REFERENCE

Every endpoint, request/response schema, filter parameter, and worked example lives in the Clumio API portal. 

Terraform Provider

Declarative protection from your IaC pipeline.