REST API - list

esx settings clusters software drafts software components: list

Returns the components that comprise the software draft.


HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components

Path Parameters

Name Type Description
cluster string Identifier of the cluster.
draft string Identifier of the working copy document.


HTTP Status Code: 200

Response Body Structure:





Name Type Description
bold = required
- object Map of component version information keyed by the component identifier.Object with element values of type component_info.
-.* component_info
-.*.version string Version of the component.

Optional. unset if version is not specified.

-.*.details component_details Details about the component.

Optional. unset if component is not present in the depot.

-.*.details.display_name string Display name of the component.

-.*.details.vendor string Vendor of the component.

-.*.details.display_version string Human readable version of the component.

Optional. unset if no version is provided for the component.


HTTP Status Code Type Description
500 error If there is some unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster or no draft associated with draft in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.