REST API - get

esx settings depot content add ons versions: get

Returns information about a given OEM add-on version in the depot.

Request:

HTTP request

GET https://{server}/api/esx/settings/depot-content/add-ons/{name}/versions/{version}

Path Parameters

Name Type Description
Required
name string Name of the OEM add-on.
version string Version of the OEM add-on.

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",
    "removed_components"[
        {
            "name""obj-103",
            "display_name""string"
        },
        {
            "name""obj-103",
            "display_name""string"
        }
    ],
    "description""string",
    "display_name""string",
    "category""SECURITY"
}

Headers:

None

Type:

Name Type Description
bold = required
- info Information about the given OEM add-on.
-.display_name string Display name of the OEM add-on.

-.vendor string Vendor of the OEM add-on.

-.display_version string Human readable version of the OEM add-on.

-.summary string Summary of the OEM add-on.

-.description string Discription of the OEM add-on.

-.category string Category of the OEM add-on.

Defines possible values of categories for a OEM add-on. Value is one of:
SECURITY: Security
ENHANCEMENT: Enhancement
BUGFIX: Bugfix

-.kb URI Link to kb article related to this the OEM add-on.

-.release_date date_time Release date of the OEM add-on.

-.components component_info[] List of components in this OEM add-on.

-.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 OEM add-on.

-.removed_components removed_component_info[] List of components removed by this OEM add-on.

-.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.

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 OEM add-on with given version is not found.
503 service_unavailable If the service is not available.
401 unauthenticated if the caller is not authenticated.