REST API - get

esx settings clusters software base image: get

Returns the desired base-image specification set for given cluster

Request:

HTTP request

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

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier of the cluster.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "details" : {
        "release_date" : "2015-01-01T22:13:05.651Z",
        "display_version" : "string",
        "display_name" : "string"
    },
    "version" : "string"
}

Headers:

None

Type:

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

Errors:

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` in the system or if desired specification is not found.
503	service_unavailable	If the service is not available.
401	unauthenticated	if the caller is not authenticated.