REST API - get

esx settings clusters software drafts software components: get

Returns the component version for the given component in the software draft.

Request:

HTTP request

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

Path Parameters

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

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "details"{
        "vendor""string",
        "display_version""string",
        "display_name""string"
    },
    "version""string"
}

Headers:

None

Type:

Name Type Description
bold = required
- component_info Optional. Information about component version.
-.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.

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 there is no cluster associated with cluster or no draft associated with draft or no component associated with component in the system.
503 service_unavailable If the service is not available.
401 unauthenticated if the caller is not authenticated.