Backup an EC2 instance on demand

Performs an on-demand backup for the specified EC2 instance.

Query Parameters

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.

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

application/json

Request Body required

instance_id uuid4 required
Performs the operation on the EC2 instance with the specified Clumio-assigned ID.
settings object
Settings for requesting on-demand backup directly.
advanced_settings object
Additional operation-specific policy settings. For operation types which do not support additional settings, this field is null.
aws_ebs_volume_backup object
Advanced settings for EBS backup.
backup_tier string
Possible values: [standard, lite]
Backup tier to store the backup in. Valid values are: (empty) equivalent to standard, standard, and lite.
aws_ec2_instance_backup object
Advanced settings for EC2 backup.
backup_tier string
Possible values: [standard, lite]
Backup tier to store the backup in. Valid values are: (empty) equivalent to standard, standard, and lite.
aws_rds_config_sync object
Advanced settings for RDS PITR configuration sync.
apply string
Possible values: [immediate, maintenance_window]
Syncs the configuration of RDS PITR in AWS. Valid values are: immediate, and maintenance_window. Note that applying the setting "immediately" may cause unexpected downtime.
aws_rds_resource_granular_backup object
Settings for determining if a RDS policy is created with standard or archive tier.
backup_tier string
Possible values: [standard, archive]
Backup tier to store the backup in. Valid values are: standard, archive
ec2_mssql_database_backup object
Additional policy configuration settings for the ec2_mssql_database_backup operation. If this operation is not of type ec2_mssql_database_backup, then this field is omitted from the response.
alternative_replica string
Possible values: [primary, sync_secondary, stop]
The alternative replica for MSSQL database backups. This setting only applies to Availability Group databases. Possible values include "primary", "sync_secondary", and "stop". If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable. Otherwise, recurring backups will attempt to use either the primary replica or the secondary replica accordingly.
preferred_replica string
Possible values: [primary, sync_secondary]
The primary preferred replica for MSSQL database backups. This setting only applies to Availability Group databases. Possible values include "primary" and "sync_secondary". Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.
ec2_mssql_log_backup object
Additional policy configuration settings for the ec2_mssql_log_backup operation. If this operation is not of type ec2_mssql_log_backup, then this field is omitted from the response.
alternative_replica string
Possible values: [primary, sync_secondary, stop]
The alternative replica for MSSQL log backups. This setting only applies to Availability Group databases. Possible values include "primary", "sync_secondary", and "stop". If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable. Otherwise, recurring backups will attempt to use either the primary replica or the secondary replica accordingly.
preferred_replica string
Possible values: [primary, sync_secondary]
The primary preferred replica for MSSQL log backups. This setting only applies to Availability Group databases. Possible values include "primary" and "sync_secondary". Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.
mssql_database_backup object
Additional policy configuration settings for the mssql_database_backup operation. If this operation is not of type mssql_database_backup, then this field is omitted from the response.
alternative_replica string
Possible values: [primary, sync_secondary, stop]
The alternative replica for MSSQL database backups. This setting only applies to Availability Group databases. Possible values include "primary", "sync_secondary", and "stop". If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable. Otherwise, recurring backups will attempt to use either the primary replica or the secondary replica accordingly.
preferred_replica string
Possible values: [primary, sync_secondary]
The primary preferred replica for MSSQL database backups. This setting only applies to Availability Group databases. Possible values include "primary" and "sync_secondary". Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.
mssql_log_backup object
Additional policy configuration settings for the mssql_log_backup operation. If this operation is not of type mssql_log_backup, then this field is omitted from the response.
alternative_replica string
Possible values: [primary, sync_secondary, stop]
The alternative replica for MSSQL log backups. This setting only applies to Availability Group databases. Possible values include "primary", "sync_secondary", and "stop". If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable. Otherwise, recurring backups will attempt to use either the primary replica or the secondary replica accordingly.
preferred_replica string
Possible values: [primary, sync_secondary]
The primary preferred replica for MSSQL log backups. This setting only applies to Availability Group databases. Possible values include "primary" and "sync_secondary". Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.
oracle_database_backup object
Additional policy configuration settings for the oracle_database_backup operation. If this operation is not of type oracle_database_backup, then this field is omitted from the response.
alternative_replica string
Possible values: [primary, standby, stop]
The alternative replica for Oracle database backups. This setting only applies to Data Guard databases. Valid values are: primary, standby, and stop. If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable.
preferred_replica string
Possible values: [primary, standby]
The primary preferred replica for Oracle database backups. This setting only applies to Data Guard databases. Valid values are: primary, and standby. Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.
oracle_log_backup object
Additional policy configuration settings for the oracle_log_backup operation. If this operation is not of type oracle_log_backup, then this field is omitted from the response.
alternative_replica string
Possible values: [primary, standby, stop]
The alternative replica for Oracle database backups. This setting only applies to Data Guard databases. Valid values are: primary, standby, and stop. If "stop" is provided, then backups will not attempt to switch to a different replica when the preferred replica is unavailable.
preferred_replica string
Possible values: [primary, standby]
The primary preferred replica for Oracle database backups. This setting only applies to Data Guard databases. Valid values are: primary, and standby. Recurring backup will first attempt to use either the primary replica or the secondary replica accordingly.
protection_group_backup object
Additional policy configuration settings for the protection_group_backup operation. If this operation is not of type protection_group_backup, then this field is omitted from the response.
backup_tier string
Possible values: [standard, archive]
Backup tier to store the backup in. Valid values are: standard, archive
protection_group_continuous_backup object
Additional policy configuration settings for the protection_group_continuous_backup operation. If this operation is not of type protection_group_continuous_backup, then this field is omitted from the response.
disable_eventbridge_notification boolean
Default value: true
If true, tries to disable EventBridge notification for the given bucket, when continuous backup no longer conducts. It may override the existing bucket notification configuration in the customer's account. This takes effect only when event_bridge_enabled is set to false.
backup_aws_region string
The region in which this backup is stored. This might be used for cross-region backup.
retention_duration object
The retention time for this SLA. For example, to retain the backup for 1 month, set unit="months" and value=1.
unit string required
Possible values: [hours, days, weeks, months, years]
The measurement unit of the SLA parameter.
value int64 required
The measurement value of the SLA parameter.
type string
The type of the backup. Possible values - clumio_backup, aws_snapshot. The type will be assumed as clumio_backup if the field is left empty.

Responses

202
default

Success

application/api.clumio.backup-aws-ec2-instances=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
read-task Embeds the associated task of a resource in the response if requested using the `embed` query parameter.
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.
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.
read-task object
A HATEOAS link to the task associated with 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
The Clumio-assigned ID of the task created for EC2 backup. The progress of the task can be monitored using the GET /tasks/{task_id} endpoint.

{
  "_embedded": {},
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "read-task": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "task_id": "string"
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

Backup an EC2 instance on demand​

Backup an EC2 instance on demand