NSX-T Data Center REST API

NSX Application Platform

Associated URIs:

API Description API Path

Get NSX Application Platform deployment configuration


Get input parameters required to deploy NSX Application Platform.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/platform

Update platform configuration


Update input parameters required to deploy platform related pods.
The UI has option to deploy kubernetes tools.
You need to get this file from VMware website.
File contains kubectl binary, helm binary and signature to verify them.
PATCH /policy/api/v1/infra/sites/{site-id}/napp/deployment/platform

Run pre/post checks for NSX Application Platform


Run pre/post checks for NSX Application Platform
PUT /policy/api/v1/infra/sites/{site-id}/napp/deployment/platform/checks

Get NSX Application Platform pre/post checks execution required


Get NSX Application Platform pre/post checks execution required.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/platform/checks/execution/required

Get NSX Application Platform pre/post checks progress status


Get NSX Application Platform pre/post checks progress status.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/platform/checks/status

Get available deployment form factors for NSX Application Platform


Get available deployment form factors for NSX Application Platform.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/platform/form-factors

Get platform deployment or undeployment progress status


Get platform deployment or undeployment progress status.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/platform/status

Get NSX Application Platform versions


Get NSX Application Platform versions.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/platform/versions

Get helm repo and docker registry url


Get helm repo and docker registry url for chart deployment.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/registry

Update Docker registry and helm repository url.


In case of helm chart present in private repository and containers
are hosted in private hub. You can change docker and helm url to use these
private URL instead of default public one.
PUT /policy/api/v1/infra/sites/{site-id}/napp/deployment/registry

Reset helm and docker url to default one


PUT /policy/api/v1/infra/sites/{site-id}/napp/deployment/registry/reset

Get list of Kubernetes storage classes


Get the list of Kubernetes storage classes.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/storage-classes

Get progress status of kubernetes tools bundle upload


Get the progress of uploading kubernetes tools bundle from the remote location.
This API will also verify the kubernetes tools bundle, before marking upload as a success.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/tools/upload/status/{bundle-id}

Upload the Kubernetes tools on NSX Manager via remote URL


Upload the Kubernetes tools on NSX Manager via remote url.
You need to get this file from VMware website.
File contains kubectl binary, helm binary and signature to verify them.
POST /policy/api/v1/infra/sites/{site-id}/napp/deployment/tools/upload_from_remote_server

Run pre/post checks for NSX Application Platform upgrade-coordinator


Run pre/post checks for NSX Application Platform upgrade-coordinator.
PUT /policy/api/v1/infra/sites/{site-id}/napp/deployment/upgrade-coordinator/checks

Get NSX Application Platform upgrade-coordinator pre/post checks progress status.


Get NSX Application Platform upgrade-coordinator pre/post checks progress status.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/upgrade-coordinator/checks/status

Get NSX Application Platform upgrade-coordinator versions


Get NSX Application Platform upgrade-coordinator versions.
GET /policy/api/v1/infra/sites/{site-id}/napp/deployment/upgrade-coordinator/versions