NSX-T Data Center REST API

Associated URIs:

API Description API Path

Create portal certificate CSR for Avi Load Balancer Controller.


Use this API to create portal certificate CSR for Avi Load Balancer Controller.
POST /policy/api/v1/alb/controller-nodes/certificate/csr

Install and update portal certificate in Avi Load Balancer Controller.


Use this API to install and update portal certificate in Avi Load Balancer Controller.
POST /policy/api/v1/alb/controller-nodes/certificate/install

Validate admin password for Avi Load Balancer Controller.


Use this API to validate admin password in Avi Load Balancer Controller.
This API is for VCF deployments only.
PUT /policy/api/v1/alb/controller-nodes/check-password

Returns information for Avi Load Balancer Controller cluster.


Returns information about Avi Load Balancer Controller cluster status
GET /policy/api/v1/alb/controller-nodes/cluster

Re-trigger clustering for Avi Load Balancer Controller Nodes.


Re-trigger clustering for Avi Load Balancer Controller Nodes.
PUT /policy/api/v1/alb/controller-nodes/cluster

Delete the cluster configuration for the Avi Load Balancer Controller cluster configuration. If Avi Load Balancer Controllers are present delete will fail.


Delete the cluster configuration for Avi Load Balancer Controller cluster.
This API is for VCF deployments only.
DELETE /policy/api/v1/alb/controller-nodes/clusterconfig

Returns info for of the cluster configuration for the Avi Load Balancer Controller cluster


Returns cluster configuration for the Avi Load Balancer Controller cluster.
GET /policy/api/v1/alb/controller-nodes/clusterconfig

Set the cluster configuration for the Avi Load Balancer Controller node. The VIP can be set once. Attempting to change the VIP once set will return an error in case Avi Controllers are deployed.


Set the cluster configuration for Avi Load Balancer Controller cluster.
POST /policy/api/v1/alb/controller-nodes/clusterconfig

Returns info for all Avi Load Balancer cluster node auto-deployment attempts


Returns request information for every attempted deployment of a Avi Load Balancer cluster
node.
GET /policy/api/v1/alb/controller-nodes/deployments

Deploy and register a Avi Load Balancer Controller node


Deploys a Avi Load Balancer Controller node as specified by the deployment config.
POST /policy/api/v1/alb/controller-nodes/deployments

Returns info for a Avi Load Balancer Controller deployment attempt


Returns deployment request information for a specific attempted
deployment of a cluster node.
GET /policy/api/v1/alb/controller-nodes/deployments/{node-id}

Attempt to delete an auto-deployed Avi Load Balancer Controller node


Attempts to unregister and undeploy a specified auto-deployed cluster
node. If it is a member of a cluster, then the node will be automatically
detached from the cluster before being unregistered and undeployed.
Alternatively, if the original deployment attempt failed or the node is
not found, cleans up the deployment information associated with the
deployment attempt.
Note: If a node has been successfully auto-deployed, then the associated
deployment information will not be deleted unless and until the node is
successfully deleted.
POST /policy/api/v1/alb/controller-nodes/deployments/{node-id}?action=delete

Update a Avi Load Balancer Controller cluster node. Only updating password, ntp and dns servers are supported. If controller is in a cluster then all nodes in the cluster are updated with the provided values


Update Avi Load Balancer Controller node details
PUT /policy/api/v1/alb/controller-nodes/deployments/{node-id}

Returns the status of the node creation/deletion


Returns the current deployment or undeployment status for a node along with
any other relevant current information, such as error messages.
GET /policy/api/v1/alb/controller-nodes/deployments/{node-id}/status

List available Avi Load Balancer Controller form factors


Returns information about all form factors available for Avi Load Balancer Controller nodes.
GET /policy/api/v1/alb/controller-nodes/form-factors

Update DNS, NTP and Backup server config in Avi Load Balancer Controller.


Use this API to update DNS, NTP and Backup server config in Avi Load Balancer Controller.
This API is for VCF deployments only.
PUT /policy/api/v1/alb/controller-nodes/system-configuration

Create service user object credential in Avi Load Balancer Controller cluster.


Use this API to create service user object credential in Avi Load Balancer Controller cluster.
This API is for VCF deployments only.
POST /policy/api/v1/alb/controller-nodes/user-credential

Update admin user or service user object password in Avi Load Balancer Controller.


Use this API to update admin user password or service user object password in Avi Load Balancer Controller.
This API is for VCF deployments only.
PUT /policy/api/v1/alb/controller-nodes/user-credential

Delete user credential from Avi Load Balancer Controller cluster.


Use this API to delete user credentials in Avi Load Balancer Controller cluster.
This API is for VCF deployments only.
DELETE /policy/api/v1/alb/controller-nodes/user-credential/{username}

Auth Token API call to Avi Controller.


Passthorugh API calls to Avi controller using the Auth of policy API
request send to this API will be passthrough to Avi controller and
Avi controller response will be embedded for this API.
PUT /policy/api/v1/infra/alb-auth-token

This is Post Avi Controller Deployment Workflow. It will create role if not exist Create Service User Set System Configuration Create Enforcement Point Save Infra-Admin Creds to DB.


Set the post deployment cluster configuration for Avi Load Balancer Controller cluster.
PUT /policy/api/v1/infra/alb-onboarding-workflow

Delete Avi EnforcementPoint and the Infra Admin credentials contained by this workflow.


Delete Avi EnforcementPoint along with Infra Admin credentials.
DELETE /policy/api/v1/infra/alb-onboarding-workflow/{managed-by}