NSX-T Data Center REST API

Associated URIs:

API Description API Path

Get status for MPS Compute collection.


Returns current status of the deployment of MPS Service on a given cluster.
GET /api/v1/malware-prevention/compute-collection/{compute-collection-id}/status

Remove service deployment


Remove the service deployment. This will remove all the Service VMs that were
created as part of this deployment on the specified cluster. User can optionally set
force delete option which will force remove the deployment, but should be used
only when the regular delete is not working. Regular delete will ensure
proper cleanup of Service VMs and related objects. Directly calling this
API without trying regular undeploy will result in unexpected results,
and orphan objects.
DELETE /api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment

Get the Malware Prevention Service deployment on the specified compute-collection


Returns detail of the Malware Prevention Service deployment.
GET /api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment

Deploys a the Malware Prevention Service on the specified compute-collection


This will deploy the Malware Prevention Service on a given cluster.
Internally OVF will be deployed on each host that is part of the cluster.
If there are no issues in the parameters, the call returns immediately,
and the service VMs will be deployed asynchronously.
To get the overall status of the deployment or to get the status of individual service vm, please use the
MPS deployment status APIs.
POST /api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment

Upgrade all VMs part of this service deployment to new OVF specification on the given datastore.


If new deployment specification is provided, the deployment will be moved to the provided specification
provided that current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL
If same deployment specification is provided, upgrade will be done only if current deployment state is
UPGRADE_FAILED
If the existing data store is upgraded or changed, there is an optional parameter to supply the new
storage Id during upgrade which would perform the deployment upgrade on the new data store
POST /api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment/action/change-appliance

List OVF specifications


List OVF specifications
GET /api/v1/malware-prevention/ovf-spec

List available regions


List available regions.
GET /api/v1/malware-prevention/teaser/regions

Registration URL


Registration URL.
POST /api/v1/malware-prevention/teaser/registration_url

Registration status


Registration status.
GET /api/v1/malware-prevention/teaser/status

Get status for MPS Transport Node.


Returns current status of the deployment of MPS Service on a transport node.
GET /api/v1/malware-prevention/transport-node/{transport-node-id}/status