Sign in

v1

latestSwagger 2.02026-07-17176789777.3 KB
batch

Submit a list of one or more intentful REST APIs to be processed

Batching allows for instructions for several operations to be sent using a single HTTP request. Depending on the batch parameters, the Nutanix v3 gateway processes each independent operation sequentially or in parallel. Once all operations in the batch have been completed, a consolidated response is returned and the HTTP connection is closed. The batch API takes an array of logical HTTP requests represented as JSON arrays. Maximum size of the array should not exceed 60. Each request comprises the following:

  • A method (corresponding to HTTP methods such as GET, PUT, and POST)
  • A relative URL (relative_url)
  • (Optional) A body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays containing the following:
  • A status code
  • (Optional) A body represented as a JSON-encoded string
post/batch

Request body

execution_orderstring

The order of execution of the APIs in the batch. Can be either Sequential (default value) or Parallel.

action_on_failurestring

If the specified parameter is CONTINUE, the remaining APIs in the batch continue to be executed.

api_versionstring required

The current API version.

Response

Success