REST API - list

esx settings depot content base images: list

Returns a list of currently available base-images in the depot.

Request:

HTTP request

GET https://{server}/api/esx/settings/depot-content/base-images

?min_version={value}

Query Parameters:

Name	Type	Description
bold = required
min_version	string	Minimum version of a base-image that can match the filter. Optional. If set, only base-images with version greater than or equal to this version will be returned.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "summary" : "string",
        "release_date" : "2015-01-01T22:13:05.651Z",
        "display_version" : "string",
        "kb" : "http://myurl.com",
        "display_name" : "string",
        "category" : "SECURITY",
        "version" : "obj-103"
    },
    {
        "summary" : "string",
        "release_date" : "2015-01-01T22:13:05.651Z",
        "display_version" : "string",
        "kb" : "http://myurl.com",
        "display_name" : "string",
        "category" : "SECURITY",
        "version" : "obj-103"
    }
]

Headers:

None

Type:

Name	Type	Description
bold = required
-	summary[]	List of base-images in the depot. These will be sorted by the version of the base-image.
-[].display_name	string	Display name of the base-image.
-[].version	string	Version of the base-image. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.settings.base_image`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.settings.base_image`.
-[].display_version	string	Human readable version of the base-image.
-[].summary	string	Summary of the base-image.
-[].category	string	Category of the base-image. Defines possible values of categories for a base-image. Value is one of: SECURITY: Security ENHANCEMENT: Enhancement BUGFIX: Bugfix
-[].kb	URI	Link to kb article related to this the base-image.
-[].release_date	date_time	Release date 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.
503	service_unavailable	If the service is not available.
401	unauthenticated	if the caller is not authenticated.