---
title: "Submit a list of one or more intentful REST APIs to be processed"
method: POST
path: "/batch"
tags: ["batch"]
---

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

`POST /batch`

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

## Request body

- BatchRequest — Request for batch operations.
  - `execution_order` string — The order of execution of the APIs in the batch. Can be either Sequential (default value) or Parallel.
  - `action_on_failure` string — If the specified parameter is CONTINUE, the remaining APIs in the batch continue to be executed.
  - `api_request_list` ApiRequest[], required — A list of API requests in the batch.
    - `body` object — The API request specification.
    - `operation` string, required — The REST method to use.
    - `path_and_params` string, required — The part of the API request that contains information such as the path and query.
  - `api_version` string, required — The current API version.

## Response `200`

Success

- BatchResponse — List of responses for the API requests in the batch.
  - `api_response_list` ApiResponse[]
    - `status` string, required
    - `api_response` object, required
    - `path_and_params` string, required — The part of API response that contains information such as the path and query.

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)