REST API - commit-task

esx settings clusters software drafts: commit-task

Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.


HTTP request

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


Path Parameters

Name Type Description
cluster string Identifier of the cluster.
draft string Identifier of the draft.

Body Parameters:

Name Type Description
bold = required
- commit_spec The spec to be used to create the commit.
-.message string Message to include with the commit.

Optional. If unset, message is set to empty string.


HTTP Status Code: 202

Response Body Structure:





Name Type Description
bold = required
- string Identifier of the commit.


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 in the system.
400 not_allowed_in_current_state If there is another operation in progress.
400 invalid_argument If validation of the software document fails. The value of the data field of vapi.std.errors.error will be a structure that contains all the fields defined in
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.