REST API - list
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. software
  6. drafts

esx settings clusters software drafts: list

Returns information about the software drafts for the specified cluster that match the esx.settings.clusters.software.drafts.filter_spec.

Request:

HTTP request

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

?owners={value-1}
&owners={value-2}

Path Parameters

Name Type Description
Required
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.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "obj-103" : {
        "metadata" : {
            "owner" : "string",
            "creation_time" : "2015-01-01T22:13:05.651Z",
            "status" : "VALID"
        }
    }
}

Headers:

None

Type:

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.

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