Jump to Content
Help Center
Clumio Terraform Provider
Clumio Python SDK
Clumio GO SDK
User Guide
API Reference
Changelog
Knowledge Base
Help Center
Clumio Terraform Provider
Clumio Python SDK
Clumio GO SDK
Blog
Changelog
Login
API Reference
Blog
Changelog
Login
User Guide
API Reference
Changelog
Knowledge Base
List users
Search
JUMP TO
Clumio REST API
Getting Started with the Clumio REST API
Authentication
Discovery API
Versioning
Organizational Units
REST Methods
HATEOAS / HAL Architecture
Filtering, Sorting, and Pagination
Response Codes
API Throttling
Data Compression
Concurrency Control
Limitations and Constraints
Common Resources
Discovery
List resources
get
Individual Alerts
List individual alerts
get
Retrieve an individual alert
get
Update an individual alert
patch
Alert types table
Consolidated Alerts
List consolidated alerts
get
Retrieve a consolidated alert
get
Update a consolidated alert
patch
Audit-Trails
List audit trails
get
Policy Definitions
List policies
get
Create a policy
post
Retrieve a policy
get
Update a policy
put
Delete a policy
delete
Policy Rules
List rules
get
Create a rule
post
Retrieve a rule
get
Update a rule
put
Delete a rule
delete
Policy Assignments
Set policy assignments
post
Reports
List generated reports
get
Generate report
post
Tasks
List tasks
get
Retrieve a task
get
Update a task
patch
Task details tables
Settings
Organizational-Units
List Organizational Units
get
Create an Organizational Unit
post
Retrieve an Organizational Unit
get
Delete Organizational Unit
delete
Patch Organizational Unit
patch
Roles
List Roles
get
Retrieve a Role
get
Auto User Provisioning
Retrieve Auto User Provisioning Settings
get
Update Auto User Provisioning Settings
put
Auto User Provisioning Rules
List Rules
get
Create a rule
post
Retrieve a rule
get
Update a rule
put
Delete a rule
delete
General Settings
Retrieve general settings
get
Update general settings
patch
Users
List users
get
Create a user
post
Retrieve a user
get
Delete a user
delete
Update a user
patch
Edit Profile
patch
Change user password
put
KMS Wallets
List Wallets
get
Create Wallet
post
Refresh Wallet
post
Read Wallet
get
Delete Wallet
delete
Post-process KMS
post
AWS
DynamoDB
List DynamoDB table backups
get
Backup a DynamoDB table on demand
post
Retrieve a DynamoDB table backup
get
List DynamoDB tables
get
Retrieve a DynamoDB table
get
Restore a DynamoDB table
post
Restore DynamoDB table records
post
EBS
List EBS volume backups
get
Back up an EBS volume on demand
post
Retrieve an EBS volume backup
get
List EBS volumes
get
Retrieve an EBS volume
get
Restore an EBS volume
post
EC2
List EC2 instance backups
get
Backup an EC2 instance on demand
post
Retrieve an EC2 instance backup
get
List EC2 instances
get
Retrieve an EC2 instance
get
Restore an EC2 instance
post
Files
Search files
get
List file versions
get
List filesystems
get
Retrieve an asset's filesystem
get
Browse a directory
get
Generate file restore passcode
post
List restored files
get
Restore Files
post
Download restored files shared by email
post
Share a file restore email
post
MS SQL Server on EC2
List EC2 MSSQL Database Backups
get
Retrieve available restore times for a given MSSQL on EC2 database
get
Backup an EC2 MSSQL asset on demand
post
Retrieve an EC2 MSSQL database backup
get
List MS SQL on EC2 instances
get
Retrieve an MS SQL on EC2 instance
get
List EC2 MSSQL hosts
get
Retrieve a host
get
List MS SQL on EC2 databases
get
Retrieve a database
get
List availability groups
get
Retrieve an availability group
get
List failover clusters
get
Retrieve a failover cluster
get
Restore an EC2 Microsoft SQL database
post
RDS
List RDS Resources
get
Retrieve an RDS resource
get
Restore an RDS resource
post
List RDS database backups
get
Retrieve an RDS database backup
get
List tables from an RDS backup
get
Retrieve table columns from an RDS backup
get
Retrieve a table from an RDS backup
get
List databases from an RDS backup
get
List compatible RDS option groups
get
List RDS database records
get
Restore RDS database records
post
S3
List protection group backups
get
Retrieve a protection group backup
get
List protection group S3 asset backups
get
Retrieve a protection group S3 asset backup
get
List S3 buckets
get
Retrieve an S3 bucket
get
Set Clumio-related properties for an S3 bucket.
patch
List protection groups
get
Retrieve a protection group
get
List S3 assets contained within protection groups.
get
Retrieve an S3 asset within a protection group
get
Get continuous backup statistics for an S3 asset within a protection group.
get
Create a protection group
post
Add bucket to protection group
post
Update a protection group
put
Delete a protection group
delete
Delete bucket from protection group
delete
Restore a protection group
post
Generate a preview of objects in a protection group backup
post
Preview a list of objects in a protection group backup
get
Restore S3 objects from a protection group
post
Preview a list of objects in an S3 asset in a protection group backup
get
Restore an S3 asset within a protection group.
post
Generate a preview of objects in an S3 asset within a protection group backup
post
S3 Instant Access
Estimate cost of an S3 instant access endpoint
post
Cost estimate details for an S3 instant access endpoint
get
List S3 Instant Access endpoints
get
Create an S3 Instant Access endpoint
post
Add IAM role to an S3 instant access endpoint
post
Update an IAM role attached to an S3 Instant Access endpoint
put
Delete an IAM role attached to an S3 instant access endpoint
delete
Read permissions for enrolled IAM roles
get
Read S3 instant access endpoint
get
Update an S3 instant access endpoint
put
Delete S3 instant access endpoint
delete
Read S3 instant access endpoint
get
AWS Regions
List AWS Regions
get
AWS Connection Templates
Read connection templates
get
Generate Connection Template
post
AWS Connections
List AWS Connections
get
Create AWS Connection
post
Retrieve an AWS Connection
get
Delete AWS Connection
delete
Update an AWS Connection
patch
Post-process AWS connection
post
AWS Connection Groups
List Connection Groups
get
Create Connection Group
post
Retrieve a Connection Group
get
Update Connection Group
put
AWS Environments
List AWS environments
get
Retrieve an AWS environment
get
AWS Tags
List AWS tags
get
Retrieve an AWS tag
get
Clumio Deprecated REST APIs
Deprecated API Versions
EBS
List EBS volume backups
get
Back up an EBS volume on demand
post
Retrieve an EBS volume backup
get
Retrieve EBS volume compliance statistics for a tag
get
VMC VM Backups
List VM backups
get
Back up a VM on demand
post
Retrieve a VM backup
get
MSSQL Backups
List Microsoft SQL Server database backups
get
Backup an Microsoft SQL Server asset on demand
post
Retrieve an Microsoft SQL Server database backup
get
MSSQL Connections
List Microsoft SQL Server hosts
get
Create Microsoft SQL Server connection
post
Delete Microsoft SQL Server host
delete
Move Microsoft SQL Server hosts
patch
Retrieve Microsoft SQL Server host
get
Create edge connector credentials for Microsoft SQL Server host
post
Organizational-Units (v1)
List Organizational Units
get
Create an Organizational Unit
post
Retrieve an Organizational Unit
get
Delete Organizational Unit
delete
Patch Organizational Unit
patch
Users (v1)
List users
get
Create a user
post
Retrieve a user
get
Delete a user
delete
Update a user
patch
MSSQL Availability Groups
List availability groups
get
Retrieve an availability group
get
MSSQL Databases
List MS SQL databases
get
Retrieve a Microsoft SQL Server database
get
Retrieve restore times for a given Microsoft SQL Server database
get
MSSQL Hosts
List Microsoft SQL Server hosts
get
Retrieve Microsoft SQL Server host
get
MSSQL Instances
List Microsoft SQL Server instances
get
Retrieve Microsoft SQL Server instance
get
VMC vCenters
List vCenter servers
get
Retrieve a vCenter server
get
VMC Data Centers
List data centers
get
Retrieve a data center
get
VMC Compute Resources
List compute resources
get
Retrieve a compute resource
get
VMC vCenter Server Hosts
List hosts
get
Retrieve a host
get
VMC VMs
List VMs
get
Retrieve a VM
get
VMC Folders
List folders
get
Retrieve a folder
get
VMC vCenter Attributes
List networks
get
Retrieve a network
get
List datastores
get
Retrieve a datastore
get
List tags
get
Retrieve a tag
get
List categories
get
Retrieve a category
get
List resource pools
get
Retrieve a resource pool
get
Retrieve compliance statistics for a tag
get
Retrieve compliance statistics for a folder
get
Retrieve compliance statistics for VMs in a vCenter server
get
Retrieve compliance statistics for a compute resource
get
Retrieve compliance statistics for a data center
get
VMC Management Groups
List management groups
get
Retrieve a management group
get
Update a management group
put
List subgroups
get
Retrieve a subgroup
get
MSSQL Restores
Restore a Microsoft SQL Server database
post
VMC VMware Restores
Restore a VM
post
Clumio REST API Versions
EBS
Restore an EBS volume
post
List users
get
https://{region}.api.clumio.com/users
Returns a list of Clumio users.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
us-west-2
.api.clumio.com
/users
RESPONSE
Click
Try It!
to start a request and see the response here!