REST API - list

esx settings depot content components: list

Returns a list of currently available components in the depot.

Request:

HTTP request

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

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

Query Parameters:

Name	Type	Description
bold = required
vendors	string[]	Vendors that a component must have to match the filter. Optional. If unset or empty, components with any vendor name match the filter.
names	string[]	Names that a component must have to match the filter. Optional. If unset or empty, components 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.component`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `com.vmware.esx.settings.component`.
versions	string[]	Versions that a component must have to match the filter. Optional. If unset or empty, components with any version will match the filter.
min_version	string	Minimum version of the component that can match the filter. Optional. If set, only components with version greater than or equal to the given version match the filter.
bundle_types	string[]	Component bundle types that a component must have to match the filter. Optional. If unset or empty, all components will match the filter.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "versions" : [
            {
                "summary" : "string",
                "urgency" : "CRITICAL",
                "release_date" : "2015-01-01T22:13:05.651Z",
                "display_version" : "string",
                "kb" : "http://myurl.com",
                "category" : "SECURITY",
                "version" : "string"
            },
            {
                "summary" : "string",
                "urgency" : "CRITICAL",
                "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",
                "urgency" : "CRITICAL",
                "release_date" : "2015-01-01T22:13:05.651Z",
                "display_version" : "string",
                "kb" : "http://myurl.com",
                "category" : "SECURITY",
                "version" : "string"
            },
            {
                "summary" : "string",
                "urgency" : "CRITICAL",
                "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 components in the depot.
-[].name	string	Name 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`.
-[].display_name	string	Display name of the component.
-[].vendor	string	Vendor of the component.
-[].versions	component_version_summary[]	Summary information about the versions of this component. These are sorted by the version.
-[].versions[].version	string	Version of the component.
-[].versions[].display_version	string	Human readable version of the component.
-[].versions[].summary	string	Summary of the component version.
-[].versions[].category	string	Category of the component version. Defines possible values of categories for a component. Value is one of: SECURITY: Security ENHANCEMENT: Enhancement BUGFIX: Bugfix RECALL: Recall RECALL_FIX: Recall-fix INFO: Info MISC: Misc GENERAL: General
-[].versions[].urgency	string	Urgency of the component version. Defines possible values of urgencies for a component. Value is one of: CRITICAL: Critical IMPORTANT: Important MODERATE: Moderate LOW: Low GENERAL: General
-[].versions[].kb	URI	Link to kb article related to this the component version.
-[].versions[].release_date	date_time	Release date of the component 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.