Register Batch Request
Enables you to make multiple API requests using a single request. The batch
API takes in an array of logical HTTP requests represented as JSON arrays.
Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the
portion of the URL after https://<nsx-mgr>/api/), optional headers
array (corresponding to HTTP headers) and an optional body (for POST and PUT
requests). The batch API returns an array of logical HTTP responses
represented as JSON arrays. Each response has a status code, an optional
headers array and an optional body (which is a JSON-encoded string).
The batch API is not supported for any of the policy multi-tenancy related
APIs. The multi-tenancy APIs start with the path
/orgs/
Support for batched operations will be removed from a future NSX release. For policy APIs, use the hierarchical API to submit a set of updates as a single operation. For other APIs, submit the operations as individual REST API calls.
Ignored (transactional atomicity flag)
{
"continue_on_error": false,
"requests": [
{
"body": {},
"method": "string",
"uri": "string"
}
]
}
Continue even if an error is encountered.
A single request within a batch of operations
OK
"BatchResponse Object"
Indicates if any of the APIs failed
Bulk list results
Optional flag indicating that all items were rolled back even if succeeded initially
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/v1/batch