REST API - list

esx settings depot content add ons: list

Returns a list of currently available OEM add-ons in the depot.

Request:

HTTP request

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

?vendors={value-1}
&vendors={value-2}
&names={value-1}
&names={value-2}
&versions={value-1}
&versions={value-2}
&min_version={value}

Query Parameters:

Name Type Description
bold = required
vendors string[] Vendors that an add-on must have to match the filter.

Optional. If unset or empty, add-ons from any vendor will match the filter.

names string[] Names that an add-on must have to match the filter.

Optional. If unset or empty, add-ons with any name will match the filter.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.esx.settings.add_on. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.esx.settings.add_on.

versions string[] Versions that an add-on must have to match the filter.

Optional. If unset or empty, add-ons with any version will match the filter.

min_version string Minimum version of an add-on that can match the filter.

Optional. If set, only OEM add-ons with version greater than or equal to this will be returned.

Response:

HTTP Status Code: 200

Response Body Structure:

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

Headers:

None

Type:

Name Type Description
bold = required
- summary[] List of OEM add-ons in the depot.
-[].name string Name of the OEM add-on.

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

-[].display_name string Display name of the OEM add-on.

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

-[].versions add_on_version_summary[] Summary information about the versions of this addon. These are sorted by the version.

-[].versions[].version string Version of the OEM add-on.

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

-[].versions[].summary string Summary of the OEM add-on version.

-[].versions[].category string Category of the OEM add-on version.

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

-[].versions[].kb URI Link to kb article related to this the OEM add-on version.

-[].versions[].release_date date_time Release date of the OEM add-on version.

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.