CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

Clone an Instance

put
https://{serverURL}/api/instances//clone

One can easily clone an instance and all containers within that instance. The containers are backed up via the backup services and used as a snapshot to produce a clone of the instance. It is possible to clone this app instance into an entirely different availability zone.

This endpoint also supports all of the same parameters as instance creation, so you can override any configuration options when provisioning the clone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Morpheus ID of the Object being referenced

Body Params
string

A name for the new cloned instance. If none is specified the existing name will be duplicated with the 'clone' suffix added.

group
object

The map containing the id of the server group you would like to clone into. Defaults to the source instance's group.

cloud
object

The map containing the id of the cloud you would like to clone into. Defaults to the source instance's cloud.

plan
object

The service plan override for the clone. Defaults to the source instance's service plan.

userGroup
object

Optional user group reference for the clone. Provide the user group id.

volumes
array of objects

The complete set of volumes for the clone. When provided, this replaces (does not merge with) the source instance's volumes.

Volume specifications define infrastructure parameters (size, datastore, type) only - the disk contents are always copied from the source instance.

volumes
networkInterfaces
array of objects

The complete set of network interfaces for the clone. When provided, this replaces (does not merge with) the source instance's network interfaces.

The Options API /api/options/zoneNetworkOptions?zoneId=5&provisionTypeId=10 can be used to see which options are available.

networkInterfaces
Azure Instance Configuration | VMWare Instance Configuration | Google Cloud Instance Configuration | Amazon Instance Configuration | Generic Instance Configuration | HVM Instance Configuration

Configuration overrides applied when provisioning the clone. Unlike volumes and networkInterfaces (which replace the source set when provided), config is merged key-by-key over the source instance's existing configuration: keys you set here override the source value, and keys you omit are inherited from the source instance.

This does not modify the source instance in any way - the merge happens only on the new clone's configuration at provision time.

The shape mirrors instance creation, so the same per-cloud configuration options can be supplied. Provide the variant that matches the target cloud type.

Responses

Updated almost 3 years ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 3 years ago

Did this page help you?