REST API - get
  1. Operations
  2. appliance
  3. update
  4. history

appliance update history: get

Returns detailed information about a particular installed update. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/rest/appliance/update/history/{version}

Path Parameters

Name Type Description
Required
version string

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "severity" : "CRITICAL",
        "update_type" : "SECURITY",
        "product" : "string",
        "description" : {
            "args" : [
                "string",
                "string"
            ],
            "default_message" : "string",
            "localized" : "string",
            "id" : "string",
            "params" : [
                {
                    "value" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : [
                                {
                                    "value" : {
                                        "dt" : "2015-01-01T22:13:05.651Z",
                                        "s" : "string",
                                        "d" : 1.5,
                                        "precision" : 1,
                                        "format" : "SHORT_DATE",
                                        "i" : 1,
                                        "l" : {
                                            "id" : "string",
                                            "params" : [
                                                {
                                                    "key" : "string"
                                                }
                                            ]
                                        }
                                    },
                                    "key" : "string"
                                }
                            ]
                        }
                    },
                    "key" : "string"
                }
            ]
        },
        "priority" : "HIGH",
        "tags" : "string",
        "size" : 1,
        "release_date" : "2015-01-01T22:13:05.651Z",
        "reboot_required" : true,
        "build" : 1,
        "vendor" : "string",
        "name" : "string",
        "knowledge_base" : "http://myurl.com",
        "update_repo" : "http://myurl.com",
        "eula_accept_time" : "2015-01-01T22:13:05.651Z",
        "install_date" : "2015-01-01T22:13:05.651Z"
    }
}

Response Type:

Name Type Description
bold = required
value info
value.name string Name of the update. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.install_date date_time Installation date and time. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.product string Product name of the update. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.vendor string Name of vendor who provided the update. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.knowledge_base URI URL for the knowledge base article describing this update. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.update_repo URI URL of the update repository from which this update was downloaded. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.build long The build number of the update. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.eula_accept_time date_time Time when the EULA was accepted for the update. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.tags string Tags associated with update (CVE Score). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

value.description localizable_message Description of the update. The short information what this update is. E.g. "Update2 for vCenter Server Appliance 6.5". This attribute was added in vSphere API 6.7.
value.description.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.description.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.description.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
value.description.params list Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
value.description.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.
value.priority string Update priority. This attribute was added in vSphere API 6.7.

Defines the update installation priority recommendations. This enumeration was added in vSphere API 6.7. Value is one of:
HIGH: Install ASAP. This constant was added in vSphere API 6.7.
MEDIUM: Install at the earliest convenience. This constant was added in vSphere API 6.7.
LOW: Install at your discretion. This constant was added in vSphere API 6.7.
value.severity string Update severity. This attribute was added in vSphere API 6.7.

Defines the severity of the issues fixed in the update. This enumeration was added in vSphere API 6.7. Value is one of:
CRITICAL: Vulnerabilities that can be exploited by an unauthenticated attacker from the Internet or those that break the guest/host Operating System isolation. The exploitation results in the complete compromise of confidentiality, integrity, and availability of user data and/or processing resources without user interaction. Exploitation could be leveraged to propagate an Internet worm or execute arbitrary code between Virtual Machines and/or the Host Operating System. This constant was added in vSphere API 6.7.
IMPORTANT: Vulnerabilities that are not rated critical but whose exploitation results in the complete compromise of confidentiality and/or integrity of user data and/or processing resources through user assistance or by authenticated attackers. This rating also applies to those vulnerabilities which could lead to the complete compromise of availability when exploitation is by a remote unauthenticated attacker from the Internet or through a breach of virtual machine isolation. This constant was added in vSphere API 6.7.
MODERATE: Vulnerabilities where the ability to exploit is mitigated to a significant degree by configuration or difficulty of exploitation, but in certain deployment scenarios could still lead to the compromise of confidentiality, integrity, or availability of user data and/or processing resources. This constant was added in vSphere API 6.7.
LOW: All other issues that have a security impact. Vulnerabilities where exploitation is believed to be extremely difficult, or where successful exploitation would have minimal impact. This constant was added in vSphere API 6.7.
value.update_type string Update category. This attribute was added in vSphere API 6.7.

Defines update type. This enumeration was added in vSphere API 6.7. Value is one of:
SECURITY: Fixes vulnerabilities, doesn't change functionality. This constant was added in vSphere API 6.7.
FIX: Fixes bugs/vulnerabilities, doesn't change functionality. This constant was added in vSphere API 6.7.
UPDATE: Changes product functionality. This constant was added in vSphere API 6.7.
UPGRADE: Introduces new features, significantly changes product functionality. This constant was added in vSphere API 6.7.
value.release_date date_time Update release date. This attribute was added in vSphere API 6.7.
value.reboot_required boolean Flag indicating whether reboot is required after update. This attribute was added in vSphere API 6.7.
value.size long Download Size of update in Megabytes. This attribute was added in vSphere API 6.7.

Errors:

HTTP Status Code Type Description
404 not_found
500 error Generic error
401 unauthenticated session is not authenticated
403 unauthorized session is not authorized to perform this operation
400 not_allowed_in_current_state if nothing is installed