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

Publish Version V2

Description

Submit image publish request. This operation will occur in background.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/imagemgmt/v1/images/{imageId}/versions/{versionId}
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

VersionPublishCreateTO of mimetype application/json Required

versionPublishCreateTO

{
    "description": "Test version",
    "timeZone": "America/Los Angeles(UTC-08:00)"
}
string
companyName Optional

Company name of the tenant


string
description Optional

Description for this version


options Optional

string
orgId Optional

Org Id with which this image would be associated.


string
providerLabel Optional

Provider label where the image is published

Possible values are: AKKAAZUREVSPHEREZEROCLOUD


array of ReplicasTO
replicas Optional

ReplicasTO of the image


string
timeZone Optional

TimeZone that will be default for desktops created with this image

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns VersionPublishTO of type application/json

Successfully accepted Image publish request

{
    "description": "Test version",
    "timeZone": "America/Los Angeles(UTC-08:00)",
    "versionId": "0123456789",
    "versionName": "1.0, 1.1.1",
    "versionStatus": "AVAILABLE"
}
string
companyName Optional

Company name of the tenant


string
description Optional

Description for this version


options Optional

string
orgId Optional

Org ID that the published image belongs to


array of ReplicasTO
replicas Optional

ReplicasTO of the image


string
timeZone Optional

TimeZone that will be default for desktops created with this image


string
versionId Optional

Id of the version that is being published


string
versionName Optional

Version name.


string
versionStatus Optional

Indicates the status of the version based on its stage in publish workflow

Possible values are: AVAILABLEDELETINGDISABLEDFAILEDIMPORT_COMPLETEIMPORT_IN_PROGRESSPARTIALLY_AVAILABLEPENDINGPUBLISH_IN_PROGRESSREPLICATION_IN_PROGRESS

Errors

Errors

400

Bad request


401

Unauthorized


403

Forbidden


404

Not found


412

Precondition failed


500

Failed to submit Image publish request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"description":"Test version","timeZone":"America/Los Angeles(UTC-08:00)"}' https://cloud.vmwarehorizon.com/imagemgmt/v1/images/{imageId}/versions/{versionId}?action=string
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?