REST API - commit-task
  1. Operations
  2. esx
  3. settings
  4. hosts
  5. software
  6. drafts

esx settings hosts 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. It will also validate the document before committing it. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}

?action=commit
&vmw-task=true
{
    "message" : "string"
}

Path Parameters

Name Type Description
Required
host string Identifier of the host.
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. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

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

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.
400 not_allowed_in_current_state If there is another operation in progress.
404 not_found If there is no host associated with host or if there is no draft associated with draft in the system.
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 esx.settings.hosts.software.drafts.validate_result.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.
400 unsupported If the host is not a standlone host, but instead part of a cluster.