List Depot Content Base Images
Released in v7.0.0 DescriptionReturns a list of currently available base-images in the depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/depot-content/base-images
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
SettingsDepotContentBaseImagesFilterSpec | The specification of matching base-images. If unset, the behavior is equivalent to a BaseImages.FilterSpec with all fields unset, which means all base-images match the filter. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
array of
SettingsDepotContentBaseImagesSummary
of type application/json
List of base-images in the depot. These will be sorted by the version of the base-image.
{
"category": "enum",
"display_name": "string",
"display_version": "string",
"kb": "string",
"release_date": "string",
"summary": "string",
"version": "string"
}| Property Name | Type | Description |
|---|---|---|
| category | SettingsDepotContentBaseImagesCategoryType Enum |
Category of the base-image. |
| display_name | string |
Display name of the base-image. |
| display_version | string |
Human readable version of the base-image. |
| kb | string |
Link to kb article related to this the base-image. |
| release_date | string |
Release date of the base-image. |
| summary | string |
Summary 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. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depot-content/base-images
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
