REST API - get

esx settings clusters software drafts software base image: get

Returns the base-image specification in a software draft.


HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image

Path Parameters

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


HTTP Status Code: 200

Response Body Structure:





Name Type Description
bold = required
- base_image_info Base-image specification.
-.details base_image_details Details about the base-image.

Optional. unset if base-image is not present in the depot.

-.details.display_name string Display name of the base-image.

-.details.display_version string Human readable version of the base-image.

-.details.release_date date_time Release date of the base-image.

-.version string Version of the base-image


HTTP Status Code Type Description
500 error If there is 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.