REST API - set

esx settings clusters software drafts software base image: set

Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists.

Request:

HTTP request

PUT https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image
{
    "version""string"
}

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.
draft string Identifier of the working copy document.

Body Parameters:

Name Type Description
bold = required
- base_image_spec Base-image specification.
-.version string Version of the base-image

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code Type Description
500 error If there is some unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster or no draft associated with draft in the system.
503 service_unavailable If the service is not available.
401 unauthenticated if the caller is not authenticated.