System Administration > Configuration > NSX Managers > API Services

Associated URIs:

API Description API Path

Register a Collection of API Calls at a Single End Point


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//projects//
This API is deprecated. Instead, use the hierarchical API in the NSX-T
policy API.
POST /policy/api/v1/batch (Deprecated)
POST /api/v1/batch (Deprecated)

Read API service properties


Read the configuration of the NSX API service.
GET /api/v1/cluster/api-service

Update API service properties


Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.
PUT /api/v1/cluster/api-service

Get information about all tasks


GET /policy/api/v1/tasks
GET /api/v1/tasks

Get information about the specified task


GET /policy/api/v1/tasks/{task-id}
GET /api/v1/tasks/{task-id}

Get the response of a task


GET /policy/api/v1/tasks/{task-id}/response
GET /api/v1/tasks/{task-id}/response