Clumio REST API

Getting Started with the Clumio REST API

Common Resources

Discovery
- List resourcesget
Individual Alerts
Consolidated Alerts
Audit-Trails
- List audit trailsget
Policy Definitions
Policy Rules
Policy Assignments
- Set policy assignmentspost
Reports
- List generated reportsget
- Generate reportpost
Tasks

Settings

Organizational-Units
Roles
- List Rolesget
- Retrieve a Roleget
Auto User Provisioning
- Retrieve Auto User Provisioning Settingsget
- Update Auto User Provisioning Settingsput
Auto User Provisioning Rules
General Settings
- Retrieve general settingsget
- Update general settingspatch
Users
KMS Wallets

AWS

DynamoDB
EBS
EC2
Files
MS SQL Server on EC2
RDS
S3
S3 Instant Access
AWS Regions
- List AWS Regionsget
AWS Connection Templates
- Read connection templatesget
- Generate Connection Templatepost
AWS Connections
AWS Connection Groups
AWS Environments
- List AWS environmentsget
- Retrieve an AWS environmentget
AWS Tags
- List AWS tagsget
- Retrieve an AWS tagget

Clumio Deprecated REST APIs

Deprecated API Versions
EBS
VMC VM Backups
MSSQL Backups
MSSQL Connections
Organizational-Units (v1)
Users (v1)
MSSQL Availability Groups
- List availability groupsget
- Retrieve an availability groupget
MSSQL Databases
MSSQL Hosts
- List Microsoft SQL Server hostsget
- Retrieve Microsoft SQL Server hostget
MSSQL Instances
- List Microsoft SQL Server instancesget
- Retrieve Microsoft SQL Server instanceget
VMC vCenters
- List vCenter serversget
- Retrieve a vCenter serverget
VMC Data Centers
- List data centersget
- Retrieve a data centerget
VMC Compute Resources
- List compute resourcesget
- Retrieve a compute resourceget
VMC vCenter Server Hosts
- List hostsget
- Retrieve a hostget
VMC VMs
- List VMsget
- Retrieve a VMget
VMC Folders
- List foldersget
- Retrieve a folderget
VMC vCenter Attributes
VMC Management Groups
MSSQL Restores
- Restore a Microsoft SQL Server databasepost
VMC VMware Restores
- Restore a VMpost

Clumio REST API Versions

EBS
- Restore an EBS volumepost

Clumio REST API

Getting Started with the Clumio REST API

Common Resources

Discovery
- List resourcesget
Individual Alerts
Consolidated Alerts
Audit-Trails
- List audit trailsget
Policy Definitions
Policy Rules
Policy Assignments
- Set policy assignmentspost
Reports
- List generated reportsget
- Generate reportpost
Tasks

Settings

Organizational-Units
Roles
- List Rolesget
- Retrieve a Roleget
Auto User Provisioning
- Retrieve Auto User Provisioning Settingsget
- Update Auto User Provisioning Settingsput
Auto User Provisioning Rules
General Settings
- Retrieve general settingsget
- Update general settingspatch
Users
KMS Wallets

AWS

DynamoDB
EBS
EC2
Files
MS SQL Server on EC2
RDS
S3
S3 Instant Access
AWS Regions
- List AWS Regionsget
AWS Connection Templates
- Read connection templatesget
- Generate Connection Templatepost
AWS Connections
AWS Connection Groups
AWS Environments
- List AWS environmentsget
- Retrieve an AWS environmentget
AWS Tags
- List AWS tagsget
- Retrieve an AWS tagget

Clumio Deprecated REST APIs

Deprecated API Versions
EBS
VMC VM Backups
MSSQL Backups
MSSQL Connections
Organizational-Units (v1)
Users (v1)
MSSQL Availability Groups
- List availability groupsget
- Retrieve an availability groupget
MSSQL Databases
MSSQL Hosts
- List Microsoft SQL Server hostsget
- Retrieve Microsoft SQL Server hostget
MSSQL Instances
- List Microsoft SQL Server instancesget
- Retrieve Microsoft SQL Server instanceget
VMC vCenters
- List vCenter serversget
- Retrieve a vCenter serverget
VMC Data Centers
- List data centersget
- Retrieve a data centerget
VMC Compute Resources
- List compute resourcesget
- Retrieve a compute resourceget
VMC vCenter Server Hosts
- List hostsget
- Retrieve a hostget
VMC VMs
- List VMsget
- Retrieve a VMget
VMC Folders
- List foldersget
- Retrieve a folderget
VMC vCenter Attributes
VMC Management Groups
MSSQL Restores
- Restore a Microsoft SQL Server databasepost
VMC VMware Restores
- Restore a VMpost

Clumio REST API Versions

EBS
- Restore an EBS volumepost

Backup an EC2 MSSQL asset on demand

post https://{region}.api.clumio.com/backups/aws/ec2-mssql/databases

Performs an on-demand backup of the specified EC2 MSSQL asset.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Query Params

embed

string

Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

Embeddable Link	Description
read-task	Embeds the associated task in the response. For example, `?embed=read-task`

For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

Body Params

asset_id

string

required

Performs the operation on the MSSQL asset with the specified Clumio-assigned ID.

settings

object

Settings for requesting on-demand backup directly.

type

string

required

The type of the backup.

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

read-task

string

Embeds the associated task of a resource in the response if requested using the embed query parameter.

_links

object

URLs to pages related to the resource.

_self

object

The HATEOAS link to this resource.

read-task

object

A HATEOAS link to the task associated with this resource.

_self

object

The HATEOAS link to this resource.

href

string

The URI for the referenced operation.

templated

boolean

Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

type

string

The HTTP method to be used with the "href" link for the referenced operation.

task_id

string

Task Id

Response body

object

errors

array of objects

A list of errors encountered during runtime.

errors

object

error_code

uint32

error_message

string

The reason for the error.

Updated over 1 year ago

Retrieve available restore times for a given MSSQL on EC2 database

Retrieve an EC2 MSSQL database backup

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://us-west-2.api.clumio.com/backups/aws/ec2-mssql/databases \
3
     --header 'accept: application/api.clumio.backup-ec2-mssql-databases=v1+json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "settings": {
8
    "retention_duration": {
9
      "unit": "hours"
10
    }
11
  },
12
  "type": "ec2_mssql_database_backup"
13
}
14
'


xxxxxxxxxx
21
 
1
{
2
  "_embedded": {},
3
  "_links": {
4
    "_self": {
5
      "href": "string",
6
      "templated": true,
7
      "type": "string"
8
    },
9
    "read-task": {
10
      "href": "string",
11
      "templated": true,
12
      "type": "string"
13
    }
14
  },
15
  "_self": {
16
    "href": "string",
17
    "templated": true,
18
    "type": "string"
19
  },
20
  "task_id": "string"
21
}

Updated over 1 year ago

Retrieve available restore times for a given MSSQL on EC2 database

Retrieve an EC2 MSSQL database backup

Did this page help you?

Clumio REST API
Getting Started with the Clumio REST API
Limitations and Constraints
Concurrency Control
Data Compression
API Throttling
Response Codes
Filtering, Sorting, and Pagination
HATEOAS / HAL Architecture
REST Methods
Organizational Units
Versioning
Discovery API
Authentication

Common Resources
Discovery
List resourcesget
Individual Alerts
Alert types table
Update an individual alertpatch
Retrieve an individual alertget
List individual alertsget
Consolidated Alerts
Update a consolidated alertpatch
Retrieve a consolidated alertget
List consolidated alertsget
Audit-Trails
List audit trailsget
Policy Definitions
Delete a policydelete
Update a policyput
Retrieve a policyget
Create a policypost
List policiesget
Policy Rules
Delete a ruledelete
Update a ruleput
Retrieve a ruleget
Create a rulepost
List rulesget
Policy Assignments
Set policy assignmentspost
Reports
Generate reportpost
List generated reportsget
Tasks
Task details tables
Update a taskpatch
Retrieve a taskget
List tasksget

Settings
Organizational-Units
Patch Organizational Unitpatch
Delete Organizational Unitdelete
Retrieve an Organizational Unitget
Create an Organizational Unitpost
List Organizational Unitsget
Roles
Retrieve a Roleget
List Rolesget
Auto User Provisioning
Update Auto User Provisioning Settingsput
Retrieve Auto User Provisioning Settingsget
Auto User Provisioning Rules
Delete a ruledelete
Update a ruleput
Retrieve a ruleget
Create a rulepost
List Rulesget
General Settings
Update general settingspatch
Retrieve general settingsget
Users
Change user passwordput
Edit Profilepatch
Update a userpatch
Delete a userdelete
Retrieve a userget
Create a userpost
List usersget
KMS Wallets
Post-process KMSpost
Delete Walletdelete
Read Walletget
Refresh Walletpost
Create Walletpost
List Walletsget

AWS
DynamoDB
Restore DynamoDB table recordspost
Restore a DynamoDB tablepost
Retrieve a DynamoDB tableget
List DynamoDB tablesget
Retrieve a DynamoDB table backupget
Backup a DynamoDB table on demandpost
List DynamoDB table backupsget
EBS
Restore an EBS volumepost
Retrieve an EBS volumeget
List EBS volumesget
Retrieve an EBS volume backupget
Back up an EBS volume on demandpost
List EBS volume backupsget
EC2
Restore an EC2 instancepost
Retrieve an EC2 instanceget
List EC2 instancesget
Retrieve an EC2 instance backupget
Backup an EC2 instance on demandpost
List EC2 instance backupsget
Files
Share a file restore emailpost
Download restored files shared by emailpost
Restore Filespost
List restored filesget
Generate file restore passcodepost
Browse a directoryget
Retrieve an asset's filesystemget
List filesystemsget
List file versionsget
Search filesget
MS SQL Server on EC2
Restore an EC2 Microsoft SQL databasepost
Retrieve a failover clusterget
List failover clustersget
Retrieve an availability groupget
List availability groupsget
Retrieve a databaseget
List MS SQL on EC2 databasesget
Retrieve a hostget
List EC2 MSSQL hostsget
Retrieve an MS SQL on EC2 instanceget
List MS SQL on EC2 instancesget
Retrieve an EC2 MSSQL database backupget
Backup an EC2 MSSQL asset on demandpost
Retrieve available restore times for a given MSSQL on EC2 databaseget
List EC2 MSSQL Database Backupsget
RDS
Restore RDS database recordspost
List RDS database recordsget
List compatible RDS option groupsget
List databases from an RDS backupget
Retrieve a table from an RDS backupget
Retrieve table columns from an RDS backupget
List tables from an RDS backupget
Retrieve an RDS database backupget
List RDS database backupsget
Restore an RDS resourcepost
Retrieve an RDS resourceget
List RDS Resourcesget
S3
Generate a preview of objects in an S3 asset within a protection group backuppost
Restore an S3 asset within a protection group.post
Preview a list of objects in an S3 asset in a protection group backupget
Restore S3 objects from a protection grouppost
Preview a list of objects in a protection group backupget
Generate a preview of objects in a protection group backuppost
Restore a protection grouppost
Delete bucket from protection groupdelete
Delete a protection groupdelete
Update a protection groupput
Add bucket to protection grouppost
Create a protection grouppost
Get continuous backup statistics for an S3 asset within a protection group.get
Retrieve an S3 asset within a protection groupget
List S3 assets contained within protection groups.get
Retrieve a protection groupget
List protection groupsget
Set Clumio-related properties for an S3 bucket.patch
Retrieve an S3 bucketget
List S3 bucketsget
Retrieve a protection group S3 asset backupget
List protection group S3 asset backupsget
Retrieve a protection group backupget
List protection group backupsget
S3 Instant Access
Read S3 instant access endpointget
Delete S3 instant access endpointdelete
Update an S3 instant access endpointput
Read S3 instant access endpointget
Read permissions for enrolled IAM rolesget
Delete an IAM role attached to an S3 instant access endpointdelete
Update an IAM role attached to an S3 Instant Access endpointput
Add IAM role to an S3 instant access endpointpost
Create an S3 Instant Access endpointpost
List S3 Instant Access endpointsget
Cost estimate details for an S3 instant access endpointget
Estimate cost of an S3 instant access endpointpost
AWS Regions
List AWS Regionsget
AWS Connection Templates
Generate Connection Templatepost
Read connection templatesget
AWS Connections
Post-process AWS connectionpost
Update an AWS Connectionpatch
Delete AWS Connectiondelete
Retrieve an AWS Connectionget
Create AWS Connectionpost
List AWS Connectionsget
AWS Connection Groups
Update Connection Groupput
Retrieve a Connection Groupget
Create Connection Grouppost
List Connection Groupsget
AWS Environments
Retrieve an AWS environmentget
List AWS environmentsget
AWS Tags
Retrieve an AWS tagget
List AWS tagsget

Clumio Deprecated REST APIs
Deprecated API Versions
EBS
Retrieve EBS volume compliance statistics for a tagget
Retrieve an EBS volume backupget
Back up an EBS volume on demandpost
List EBS volume backupsget
VMC VM Backups
Retrieve a VM backupget
Back up a VM on demandpost
List VM backupsget
MSSQL Backups
Retrieve an Microsoft SQL Server database backupget
Backup an Microsoft SQL Server asset on demandpost
List Microsoft SQL Server database backupsget
MSSQL Connections
Create edge connector credentials for Microsoft SQL Server hostpost
Retrieve Microsoft SQL Server hostget
Move Microsoft SQL Server hostspatch
Delete Microsoft SQL Server hostdelete
Create Microsoft SQL Server connectionpost
List Microsoft SQL Server hostsget
Organizational-Units (v1)
Patch Organizational Unitpatch
Delete Organizational Unitdelete
Retrieve an Organizational Unitget
Create an Organizational Unitpost
List Organizational Unitsget
Users (v1)
Update a userpatch
Delete a userdelete
Retrieve a userget
Create a userpost
List usersget
MSSQL Availability Groups
Retrieve an availability groupget
List availability groupsget
MSSQL Databases
Retrieve restore times for a given Microsoft SQL Server databaseget
Retrieve a Microsoft SQL Server databaseget
List MS SQL databasesget
MSSQL Hosts
Retrieve Microsoft SQL Server hostget
List Microsoft SQL Server hostsget
MSSQL Instances
Retrieve Microsoft SQL Server instanceget
List Microsoft SQL Server instancesget
VMC vCenters
Retrieve a vCenter serverget
List vCenter serversget
VMC Data Centers
Retrieve a data centerget
List data centersget
VMC Compute Resources
Retrieve a compute resourceget
List compute resourcesget
VMC vCenter Server Hosts
Retrieve a hostget
List hostsget
VMC VMs
Retrieve a VMget
List VMsget
VMC Folders
Retrieve a folderget
List foldersget
VMC vCenter Attributes
Retrieve compliance statistics for a data centerget
Retrieve compliance statistics for a compute resourceget
Retrieve compliance statistics for VMs in a vCenter serverget
Retrieve compliance statistics for a folderget
Retrieve compliance statistics for a tagget
Retrieve a resource poolget
List resource poolsget
Retrieve a categoryget
List categoriesget
Retrieve a tagget
List tagsget
Retrieve a datastoreget
List datastoresget
Retrieve a networkget
List networksget
VMC Management Groups
Retrieve a subgroupget
List subgroupsget
Update a management groupput
Retrieve a management groupget
List management groupsget
MSSQL Restores
Restore a Microsoft SQL Server databasepost
VMC VMware Restores
Restore a VMpost

Clumio REST API Versions
EBS
Restore an EBS volumepost

Clumio REST API
Getting Started with the Clumio REST API
Limitations and Constraints
Concurrency Control
Data Compression
API Throttling
Response Codes
Filtering, Sorting, and Pagination
HATEOAS / HAL Architecture
REST Methods
Organizational Units
Versioning
Discovery API
Authentication

Common Resources
Discovery
List resourcesget
Individual Alerts
Alert types table
Update an individual alertpatch
Retrieve an individual alertget
List individual alertsget
Consolidated Alerts
Update a consolidated alertpatch
Retrieve a consolidated alertget
List consolidated alertsget
Audit-Trails
List audit trailsget
Policy Definitions
Delete a policydelete
Update a policyput
Retrieve a policyget
Create a policypost
List policiesget
Policy Rules
Delete a ruledelete
Update a ruleput
Retrieve a ruleget
Create a rulepost
List rulesget
Policy Assignments
Set policy assignmentspost
Reports
Generate reportpost
List generated reportsget
Tasks
Task details tables
Update a taskpatch
Retrieve a taskget
List tasksget

Settings
Organizational-Units
Patch Organizational Unitpatch
Delete Organizational Unitdelete
Retrieve an Organizational Unitget
Create an Organizational Unitpost
List Organizational Unitsget
Roles
Retrieve a Roleget
List Rolesget
Auto User Provisioning
Update Auto User Provisioning Settingsput
Retrieve Auto User Provisioning Settingsget
Auto User Provisioning Rules
Delete a ruledelete
Update a ruleput
Retrieve a ruleget
Create a rulepost
List Rulesget
General Settings
Update general settingspatch
Retrieve general settingsget
Users
Change user passwordput
Edit Profilepatch
Update a userpatch
Delete a userdelete
Retrieve a userget
Create a userpost
List usersget
KMS Wallets
Post-process KMSpost
Delete Walletdelete
Read Walletget
Refresh Walletpost
Create Walletpost
List Walletsget

AWS
DynamoDB
Restore DynamoDB table recordspost
Restore a DynamoDB tablepost
Retrieve a DynamoDB tableget
List DynamoDB tablesget
Retrieve a DynamoDB table backupget
Backup a DynamoDB table on demandpost
List DynamoDB table backupsget
EBS
Restore an EBS volumepost
Retrieve an EBS volumeget
List EBS volumesget
Retrieve an EBS volume backupget
Back up an EBS volume on demandpost
List EBS volume backupsget
EC2
Restore an EC2 instancepost
Retrieve an EC2 instanceget
List EC2 instancesget
Retrieve an EC2 instance backupget
Backup an EC2 instance on demandpost
List EC2 instance backupsget
Files
Share a file restore emailpost
Download restored files shared by emailpost
Restore Filespost
List restored filesget
Generate file restore passcodepost
Browse a directoryget
Retrieve an asset's filesystemget
List filesystemsget
List file versionsget
Search filesget
MS SQL Server on EC2
Restore an EC2 Microsoft SQL databasepost
Retrieve a failover clusterget
List failover clustersget
Retrieve an availability groupget
List availability groupsget
Retrieve a databaseget
List MS SQL on EC2 databasesget
Retrieve a hostget
List EC2 MSSQL hostsget
Retrieve an MS SQL on EC2 instanceget
List MS SQL on EC2 instancesget
Retrieve an EC2 MSSQL database backupget
Backup an EC2 MSSQL asset on demandpost
Retrieve available restore times for a given MSSQL on EC2 databaseget
List EC2 MSSQL Database Backupsget
RDS
Restore RDS database recordspost
List RDS database recordsget
List compatible RDS option groupsget
List databases from an RDS backupget
Retrieve a table from an RDS backupget
Retrieve table columns from an RDS backupget
List tables from an RDS backupget
Retrieve an RDS database backupget
List RDS database backupsget
Restore an RDS resourcepost
Retrieve an RDS resourceget
List RDS Resourcesget
S3
Generate a preview of objects in an S3 asset within a protection group backuppost
Restore an S3 asset within a protection group.post
Preview a list of objects in an S3 asset in a protection group backupget
Restore S3 objects from a protection grouppost
Preview a list of objects in a protection group backupget
Generate a preview of objects in a protection group backuppost
Restore a protection grouppost
Delete bucket from protection groupdelete
Delete a protection groupdelete
Update a protection groupput
Add bucket to protection grouppost
Create a protection grouppost
Get continuous backup statistics for an S3 asset within a protection group.get
Retrieve an S3 asset within a protection groupget
List S3 assets contained within protection groups.get
Retrieve a protection groupget
List protection groupsget
Set Clumio-related properties for an S3 bucket.patch
Retrieve an S3 bucketget
List S3 bucketsget
Retrieve a protection group S3 asset backupget
List protection group S3 asset backupsget
Retrieve a protection group backupget
List protection group backupsget
S3 Instant Access
Read S3 instant access endpointget
Delete S3 instant access endpointdelete
Update an S3 instant access endpointput
Read S3 instant access endpointget
Read permissions for enrolled IAM rolesget
Delete an IAM role attached to an S3 instant access endpointdelete
Update an IAM role attached to an S3 Instant Access endpointput
Add IAM role to an S3 instant access endpointpost
Create an S3 Instant Access endpointpost
List S3 Instant Access endpointsget
Cost estimate details for an S3 instant access endpointget
Estimate cost of an S3 instant access endpointpost
AWS Regions
List AWS Regionsget
AWS Connection Templates
Generate Connection Templatepost
Read connection templatesget
AWS Connections
Post-process AWS connectionpost
Update an AWS Connectionpatch
Delete AWS Connectiondelete
Retrieve an AWS Connectionget
Create AWS Connectionpost
List AWS Connectionsget
AWS Connection Groups
Update Connection Groupput
Retrieve a Connection Groupget
Create Connection Grouppost
List Connection Groupsget
AWS Environments
Retrieve an AWS environmentget
List AWS environmentsget
AWS Tags
Retrieve an AWS tagget
List AWS tagsget

Clumio Deprecated REST APIs
Deprecated API Versions
EBS
Retrieve EBS volume compliance statistics for a tagget
Retrieve an EBS volume backupget
Back up an EBS volume on demandpost
List EBS volume backupsget
VMC VM Backups
Retrieve a VM backupget
Back up a VM on demandpost
List VM backupsget
MSSQL Backups
Retrieve an Microsoft SQL Server database backupget
Backup an Microsoft SQL Server asset on demandpost
List Microsoft SQL Server database backupsget
MSSQL Connections
Create edge connector credentials for Microsoft SQL Server hostpost
Retrieve Microsoft SQL Server hostget
Move Microsoft SQL Server hostspatch
Delete Microsoft SQL Server hostdelete
Create Microsoft SQL Server connectionpost
List Microsoft SQL Server hostsget
Organizational-Units (v1)
Patch Organizational Unitpatch
Delete Organizational Unitdelete
Retrieve an Organizational Unitget
Create an Organizational Unitpost
List Organizational Unitsget
Users (v1)
Update a userpatch
Delete a userdelete
Retrieve a userget
Create a userpost
List usersget
MSSQL Availability Groups
Retrieve an availability groupget
List availability groupsget
MSSQL Databases
Retrieve restore times for a given Microsoft SQL Server databaseget
Retrieve a Microsoft SQL Server databaseget
List MS SQL databasesget
MSSQL Hosts
Retrieve Microsoft SQL Server hostget
List Microsoft SQL Server hostsget
MSSQL Instances
Retrieve Microsoft SQL Server instanceget
List Microsoft SQL Server instancesget
VMC vCenters
Retrieve a vCenter serverget
List vCenter serversget
VMC Data Centers
Retrieve a data centerget
List data centersget
VMC Compute Resources
Retrieve a compute resourceget
List compute resourcesget
VMC vCenter Server Hosts
Retrieve a hostget
List hostsget
VMC VMs
Retrieve a VMget
List VMsget
VMC Folders
Retrieve a folderget
List foldersget
VMC vCenter Attributes
Retrieve compliance statistics for a data centerget
Retrieve compliance statistics for a compute resourceget
Retrieve compliance statistics for VMs in a vCenter serverget
Retrieve compliance statistics for a folderget
Retrieve compliance statistics for a tagget
Retrieve a resource poolget
List resource poolsget
Retrieve a categoryget
List categoriesget
Retrieve a tagget
List tagsget
Retrieve a datastoreget
List datastoresget
Retrieve a networkget
List networksget
VMC Management Groups
Retrieve a subgroupget
List subgroupsget
Update a management groupput
Retrieve a management groupget
List management groupsget
MSSQL Restores
Restore a Microsoft SQL Server databasepost
VMC VMware Restores
Restore a VMpost

Clumio REST API Versions
EBS
Restore an EBS volumepost

202202 HTTP success response

defaultError