[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Clone

Description

Submit request to clone existing version.

It can be cloned either as a new version in same image or as a new Image altogether.

Use ?action=clone-image to create new image and ?action=clone-version to create a new version.

This operation will occur in background.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/imagemgmt/v1/images/{imageId}/versions/{versionId}/clone
Copy

Path Parameters

Path Parameters

string
imageId Required

imageId


string
versionId Required

versionId


Query Parameters

Query Parameters

string
action Required

action


Request Body

Request Body

VersionCloneCreateTO of mimetype application/json Required

versionCloneCreateTO

{
    "versionType": "MAJOR, MINOR"
}
assetDetails Optional

string
imageDescription Optional

Image Description, this is mandatory only when cloning new Image from existing Version.


string
imageName Optional

Image Name, this is mandatory only when cloning new Image from existing Version.


string
orgId Optional

Org Id


string
versionDescription Optional

Description of new Version.


string
versionType Optional

Version Type is mandatory. It can be passed as Major when creating new Image from existing Version

Possible values are: MAJORMINORPATCH

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns VersionCloneTO of type application/json

Successfully created a cloned version record.Provisioning of resources in provider will happen in background.

{
	"assetDetails": {
		"assetType": "AKKA_IMAGE_IN_RG",
		"data": {}
	},
	"assetId": "string",
	"assetStatus": "AGENT_INSTALLATION_FAILED",
	"assetType": "AKKA_IMAGE_IN_RG",
	"imageDescription": "string",
	"imageId": "string",
	"imageName": "string",
	"imageStatus": "AVAILABLE",
	"sourceAssetId": "string",
	"sourceImageId": "string",
	"sourceImageType": "AKKA_CUSTOM_VM",
	"sourceVersionId": "string",
	"versionDescription": "string",
	"versionHistory": [
		"string"
	],
	"versionId": "string",
	"versionName": "string",
	"versionStatus": "AVAILABLE",
	"versionType": "MAJOR"
}
assetDetails Optional

string
assetId Optional

string
assetStatus Optional

Possible values are: AGENT_INSTALLATION_FAILEDALLOW_RDP_FAILEDAVAILABLECAPTURING_AND_UPLOADING_IMAGE_TO_SIGCLONE_FAILEDCOPYING_IMAGEDELETINGDELETION_FAILEDDELETION_RETRY_PENDINGDEPLOYING_VMDISABLEDENABLING_RDS_AND_ALLOW_RDP_FAILEDGENERALIZINGGENERALIZING_FAILEDIMPORT_COMPLETEIMPORT_FAILEDIMPORT_FAILED_TIMEOUTIMPORT_PENDINGIMPORT_RETRY_PENDINGINSTALLING_AGENTSPUBLISH_COMPLETEPUBLISH_FAILEDPUBLISH_IN_PROGRESSPUBLISH_RETRY_PENDINGREPLICATINGREPLICATION_COMPLETEREPLICATION_FAILEDREPLICATION_FAILED_TIMEOUTRESTARTING_VMSCANNING_APPSSHUTTING_DOWN_VMSYSPREPINGSYSPREP_FAILED


string
assetType Optional

Possible values are: AKKA_IMAGE_IN_RGAKKA_VM_IN_RGAZURE_IMAGE_IN_RGAZURE_IMAGE_IN_SIGAZURE_IMAGE_REPLICA_IN_SIGAZURE_VM_IN_RGVSPHERE_MASTER_VM


string
imageDescription Optional

string
imageId Optional

string
imageName Optional

string
imageStatus Optional

Possible values are: AVAILABLEDELETINGDISABLEDFAILEDIMPORT_COMPLETEIN_PROGRESSPARTIALLY_AVAILABLEPENDING


string
sourceAssetId Optional

string
sourceImageId Optional

string
sourceImageType Optional

Possible values are: AKKA_CUSTOM_VMAKKA_MARKET_PLACEAKKA_SIGAZURE_CUSTOM_VMAZURE_MARKET_PLACEAZURE_SIGCOPIED_FROM_VERSIONIMPORTED_VMSUPLOADEDVSPHERE_CATALOG


string
sourceVersionId Optional

string
versionDescription Optional

array of string
versionHistory Optional

string
versionId Optional

string
versionName Optional

string
versionStatus Optional

Possible values are: AVAILABLEDELETINGDISABLEDFAILEDIMPORT_COMPLETEIMPORT_IN_PROGRESSPARTIALLY_AVAILABLEPENDINGPUBLISH_IN_PROGRESSREPLICATION_IN_PROGRESS


string
versionType Optional

Possible values are: MAJORMINORPATCH

Errors

Errors

400

Bad request


401

Unauthorized


403

Forbidden


404

Version is not found for given imageId and versionId


409

Conflict


500

Failed to submit version clone request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"versionType":"MAJOR, MINOR"}' https://cloud.vmwarehorizon.com/imagemgmt/v1/images/{imageId}/versions/{versionId}/clone?action=string
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: versionCloneCreateTO


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?