REST API - list

esx settings clusters software drafts: list

Returns information about the software drafts for the specified cluster that match the


HTTP request

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


Path Parameters

Name Type Description
cluster string Identifier of the cluster.

Query Parameters:

Name Type Description
bold = required
owners string[] Owners of the drafts.

Optional. If unset or empty, drafts from all owners will be returned.


HTTP Status Code: 200

Response Body Structure:





Name Type Description
bold = required
- object Map of software drafts keyed by their identifiers.Object with element values of type summary.
-.* summary
-.*.metadata metadata Metadata about the software draft.

-.*.metadata.owner string Owner of the software draft.

-.*.metadata.status string Status of the software draft.

Defines possible values of status of a software draft. Value is one of:
VALID: Software draft is valid.
INVALID: Software draft is invalid.

-.*.metadata.creation_time date_time Creation time of the software draft.


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 in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.