REST API - get

esx settings depot content hardware support manifests versions: get

Returns a complete description of a Hardware Support Package (HSP) manifest in the depot (including component lists)

Request:

HTTP request

GET https://{server}/api/esx/settings/depot-content/hardware-support/manifests/{manifest}/versions/{version}

Path Parameters

Name	Type	Description
Required
manifest	string	name of the target HSP manifest.
version	string	version of the target HSP manifest.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "summary" : "string",
    "components" : [
        {
            "display_version" : "string",
            "name" : "obj-103",
            "display_name" : "string",
            "version" : "string"
        },
        {
            "display_version" : "string",
            "name" : "obj-103",
            "display_name" : "string",
            "version" : "string"
        }
    ],
    "release_date" : "2015-01-01T22:13:05.651Z",
    "vendor" : "string",
    "display_version" : "string",
    "kb" : "http://myurl.com",
    "base_image_versions" : [
        "string",
        "string"
    ],
    "removed_components" : [
        {
            "name" : "obj-103",
            "display_name" : "string"
        },
        {
            "name" : "obj-103",
            "display_name" : "string"
        }
    ],
    "description" : "string",
    "hardware_support_info" : {
        "manager" : "obj-103",
        "pkg_source" : {
            "name" : "obj-103",
            "version" : "string"
        }
    },
    "display_name" : "string",
    "category" : "SECURITY"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Information for target HSP manifest in the depot.
-.display_name	string	Display name of the OEM add-on.
-.vendor	string	Vendor of the HSP manifest.
-.display_version	string	Human readable version of the HSP manifest.
-.summary	string	Summary of the HSP manifest.
-.description	string	Description of the HSP manifest.
-.category	string	Category of the HSP manifest. Defines possible values of categories for a OEM add-on. Value is one of: SECURITY: Security ENHANCEMENT: Enhancement BUGFIX: Bugfix
-.kb	URI	Link to documentation article related to this the HSP manifest.
-.release_date	date_time	Release date of the HSP manifest.
-.components	component_info[]	List of components in this HSP manifest.
-.components[].name	string	Identifier of the component. 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.component`. 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.component`.
-.components[].display_name	string	Display name of the component.
-.components[].version	string	Version of the component.
-.components[].display_version	string	Human readable version of the HSP manifest.
-.removed_components	removed_component_info[]	List of components removed by this HSP manifest.
-.removed_components[].name	string	Identifier of the component. 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.component`. 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.component`.
-.removed_components[].display_name	string	Display name of the component.
-.base_image_versions	string[]	Set of compatible base image versions, possibly truncated to at most the update string (e.g. "7.0.1" for "7.0u1") if the remainder should be wildcarded.
-.hardware_support_info	hardware_support_source_info	Link back to the HW support package referring to this manifest
-.hardware_support_info.manager	string	Manager for the HSP manifest (the HW Support Manager, or HSM). When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.setting.hardware_support.manager`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.setting.hardware_support.manager`.
-.hardware_support_info.pkg_source	hardware_support_source_package_info	Specific package for the HSP manifest.
-.hardware_support_info.pkg_source.name	string	Package for the HSP manifest. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.setting.hardware_support.package`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.setting.hardware_support.package`.
-.hardware_support_info.pkg_source.version	string	Package version for the HSP manifest.

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.
400	invalid_argument	If a required parameter is invalid or missing.
404	not_found	If there is no manifest with the specified name in the depot.
503	service_unavailable	If the service is not available.
401	unauthenticated	if the caller is not authenticated.
403	unauthorized	if the caller is not authorized to access the info.