Deprecated: Please use below Policy API. GET /policy/api/v1/global-infra/segments/<tier0-ls>/inter-site-forwarder/site-span-info?enforcement_point_path=/infra/sites/default/enforcement-points/default
Federation > Inter-Sites Get inter-site BGP summary of edge node
Deprecated: Please use below Policy API. GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<tier0-locale-service>/inter-site/bgp-summary GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<tier1-locale-service>/inter-site/bgp-summary
Federation > Security > East West Security > Distributed Firewall > Settings > Distributed Firewall Settings Get global distributed firewall configuration for the specified site
Federation > Security > East West Security > Distributed Firewall > Settings > Distributed Firewall Settings Get global distributed firewall configurations for all the sites
Policy > Infra > Enforcement Points > Edge Transport Nodes > Transport Node Status Get high-level summary of all edge transport nodes. The service layer does not support source = realtime or cached.
Policy > Inventory > Groups > Group Members Get logical ports that belong to this Group
Deprecated: This rest routine is deprecated. Use /infra/domains/<domain-id>/groups/<group-id>/members/segment-ports instead for effective segment-port members as LogicalPort
is not a supported member type .
Policy > Inventory > Groups > Group Members Get logical switches that belong to this Group
Deprecated: This rest routine is deprecated. Use /infra/domains/<domain-id>/groups/<group-id>/members/segments instead for effective segment members as LogicalSwitch
is not a supported member type.
Policy > Inventory > Profiles > Context Profiles Update custom object attribute value list for given attribute key
Deprecated: This rest routine is deprecated. Use /infra/context-profiles/custom-attributes/default
for create/update custom object attribute value list for given attribute key
Policy > Monitoring > Capacity Dashboard Returns capacity usage data for NSX objects
Deprecated: This API is no longer been used by UI, please use below policy api instead. GET https://<nsx-mgr>/policy/api/v1/infra/capacity/dashboard/usage
Policy > Monitoring > Online Diagnostic System Install the Dynamic Runbook package.
Please specify the header "Content-Type: application/octet-stream" in the http request.
Policy > Monitoring > Port Mirroring > Legacy Management Plane List all mirror sessions
Deprecated: This api is now deprecated. Depending on source of port mirroring, use the following apis -
Tier-1 Segment: /infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps
Tier-1 Segment Port: /infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps
Group: /infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps
Infra Segment: /infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps
Infra Segment Port: /infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps
Policy > Monitoring > Port Mirroring > Legacy Management Plane Get the mirror stack status on given remote L3 mirror session
Deprecated: This api is now deprecated. Depending on source of port mirroring, use the following apis -
Tier-1 Segment: /infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>/mirror-stack-status
Tier-1 Segment Port: /infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>/mirror-stack-status
Group: /infra/domains/<domain-id>/groups/<group-id>/group-monitoring-profile-binding-maps/<group-monitoring-profile-binding-map-id>/mirror-stack-status
Infra Segment: /infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>/mirror-stack-status
Infra Segment Port: /infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>/mirror-stack-status
Policy > Monitoring > Traceflow Create or update a traceflow config
Deprecated: Please use PUT API to start new Traceflow sessions. By default, traceflow observations will be cleanup every two hours,
please use is_transient flag to avoid the cleanup.
Policy > Monitoring > Traceflow Restart traceflow with same set of parameters used during create/update traceflow
Deprecated: Please use PUT API to start new Traceflow sessions. By default, traceflow observations will be cleanup every two hours,
please use is_transient flag to avoid the cleanup.
Policy > Networking > Connectivity > Segments > Bridge Endpoints > Statistics Get infra segment bridge end point statistics using segment ID and profile path.
Policy > Networking > Connectivity > Segments > Bridge Endpoints > Statistics Get Tier-1 segment bridge end point status using segment ID and profile path.
Policy > Networking > Connectivity > Segments > Bridge Endpoints > Statistics Get Tier-1 segment bridge end point statistics using segment ID and profile path.
Policy > Networking > Connectivity > Segments > Bridge Endpoints > Statistics Get Tier-1 segment bridge end point status using segment ID and profile path.
Policy > Networking > Connectivity > Segments > Ports Delete a Tier-1 segment port. Please note that this operation will not delete the
segment port from vCenter Server if the port was connected to a Virtual Machine.
Please connect Virtual Machine to another network for the segment port to be deleted
from vCenter Server.
Policy > Networking > Connectivity > Segments > Segment Profiles > Monitoring Profile Binding Get mirror stack status for Infra Port Monitoring Profile Binding Map
Policy > Networking > Connectivity > Segments > Segments (Fixed) Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance.
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table Get ARP table for downlink router port on tier-0 router
Deprecated: This API is deprecated because it is duplicate.
Please use /infra/segments/<segment-id>/arp-table
Segment ID is the ID of the segment that is connected to the the tier-0
Policy > Networking > Connectivity > Tier-0 Gateways > Interfaces > ARP Table Get ARP table for downlink router port on tier-0 router in CSV
Deprecated: This API is deprecated because it is duplicate.
Please use /infra/segments/<segment-id>/arp-table?format=csv
Segment ID is the ID of the segment that is connected to the the tier-0
Policy > Networking > Connectivity > Tier-0 Gateways > Routing > Static Routes BFD Peers Delete this StaticRouteBfdPeer and all the entities contained by it.
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table Get ARP table for downlink router port on tier-1 router
Deprecated: This API is deprecated because it is duplicate.
Please use /infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table
Segment ID is the ID of the segment that is connected to the the tier-1
Policy > Networking > Connectivity > Tier-1 Gateways > Interfaces > ARP Table Get ARP table for downlink router port on tier-1 router in CSV
Deprecated: This API is deprecated because it is duplicate.
Please use /infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table?format=csv
Segment ID is the ID of the segment that is connected to the the tier-1
Policy > Networking > Network Services > Load Balancing > Load Balancer Virtual Servers Delete LBVirtualServer and all the entities contained by this LBVirtualServer.
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Get IPSec VPN local endpoint list result
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Delete IPSec VPN local endpoint
Deprecated: This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Get IPSec VPN local endpoint
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Create or patch a custom IPSec VPN local endpoint
Deprecated: This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Create or fully replace IPSec VPN local endpoint
Deprecated: This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id> instead.
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Get IPSec VPN local endpoint list result
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Delete IPSec VPN local endpoint
Deprecated: This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Get IPSec VPN local endpoint
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Create or patch a custom IPSec VPN local endpoint
Deprecated: This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Policy > Networking > Network Services > VPN > IPSEC > Local Endpoints Create or fully replace IPSec VPN local endpoint
Deprecated: This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
local-endpoints/<local-endpoint-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Deprecated: This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > IPSEC > Services Get IPSec VPN service
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Services Create or patch IPSec VPN service
Deprecated: This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/
ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > IPSEC > Services Create or fully replace IPSec VPN service
Deprecated: This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > IPSEC > Services Get IPSec VPN service list result
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Deprecated: This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/psec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Policy > Networking > Network Services > VPN > IPSEC > Services Get IPSec VPN service
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Services Create or patch IPSec VPN service
Deprecated: This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > IPSEC > Services Create or fully replace IPSec VPN service
Deprecated: This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > IPSEC > Sessions Get IPSec VPN sessions list result
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Deprecated: This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Sessions Create or patch an IPSec VPN session
Deprecated: This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Deprecated: This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Policy > Networking > Network Services > VPN > IPSEC > Sessions Get IPSec VPN configuration for the peer site
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config instead.
Note:
Please note that request is validated and any error messages returned from validation may include
the new VPN path instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Sessions Get IPSec VPN sessions list result
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Deprecated: This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the
new VPN path instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>?action=show_sensitive_data instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Sessions Create or patch an IPSec VPN session
Deprecated: This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path
Deprecated: This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > IPSEC > Sessions Get IPSec VPN configuration for the peer site
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/peer-config instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > IPSEC > Statistics Get IPSec VPN session statistics under Tier-0
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/statisticsinstead.
Policy > Networking > Network Services > VPN > IPSEC > Statistics Reset the statistics of the given VPN session
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/statistics instead.
Policy > Networking > Network Services > VPN > IPSEC > Statistics Get IPSec VPN session statistics under Tier-1
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/statistics instead.
Policy > Networking > Network Services > VPN > IPSEC > Statistics Reset the statistics of the given VPN session
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/statistics instead.
Policy > Networking > Network Services > VPN > IPSEC > Status Get IPSec VPN session detailed status under Tier-0
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/
sessions/<session-id>/detailed-status instead.
Policy > Networking > Network Services > VPN > IPSEC > Status Get IPSec VPN session detailed status under Tier-1
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/sessions/<session-id>/detailed-status instead.
Policy > Networking > Network Services > VPN > L2VPN > Services Get L2VPN service list result under Tier-0
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > L2VPN > Services Delete L2VPN service under Tier-0
Deprecated: This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Services Get L2VPN service under Tier-0
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > L2VPN > Services Create or patch L2VPN service under Tier-0
Deprecated: This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the
new VPN path instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Services Create or fully replace L2VPN service under Tier-0
Deprecated: This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Services Get L2VPN service list result under Tier-1
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > L2VPN > Services Delete L2VPN service under Tier-1
Deprecated: This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Services Get L2VPN service under Tier-1
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > L2VPN > Services Create or patch L2VPN service under Tier-1
Deprecated: This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Services Create or fully replace L2VPN service under Tier-1
Deprecated: This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Get L2VPN sessions list result under Tier-0
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Deprecated: This API is deprecated. Please use DELETE /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the
new VPN path instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Get L2VPN Session under Tier-0
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions/<session-id> instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Create or patch an L2VPN session under Tier-0
Deprecated: This API is deprecated. Please use PATCH /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Create or patch an L2VPN session under Tier-0 from Peer Codes
Deprecated: This API is deprecated. Please use POST /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code instead.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Create or fully replace L2VPN session under Tier-0
Deprecated: This API is deprecated. Please use PUT /infra/tier-0s/<tier-0-id>/
l2vpn-services/<service-id>/sessions/<session-id> instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Get Tier-0 L2VPN session configuration for the peer site
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/
sessions/<session-id>/peer-config instead.
Note:
The "transport_tunnel_path" returned in the payload wil be a new vpn path instead of the deprecated API path.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Get L2VPN sessions list result under Tier-1
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Deprecated: This API is deprecated. Please use DELETE /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Get L2VPN Session under Tier-1
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Create or patch an L2VPN session under Tier-1
Deprecated: This API is deprecated. Please use PATCH /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Create or patch an L2VPN session under Tier-1 from Peer Codes
Deprecated: This API is deprecated. Please use POST /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions/<session-id>?action=create_with_peer_code instead.
Note:
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Create or fully replace L2VPN session under Tier-1
Deprecated: This API is deprecated. Please use PUT /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id> instead.
Note:
The API will return a new VPN path for "transport_tunnels" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Also VPN path returned in the Alarm, GPRR payload may include the new VPN path.
Policy > Networking > Network Services > VPN > L2VPN > Sessions Get Tier-1 L2VPN session configuration for the peer site
Deprecated: This API is deprecated. Please use GET /infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/
sessions/<session-id>/peer-config instead.
Note:
The API will return a new VPN path for "transport_tunnel_path" in the response payload instead of the deprecated API path
Both paths refer to the same object.
Please note that request is validated and any error messages returned from validation may include the new VPN path
instead of the deprecated path. Both new path and old path refer to same resource.
Policy > Networking > Network Services > VPN > L2VPN > Status Get L2VPN session detailed status under Tier-0
Deprecated: This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/
sessions/<session-id>/detailed-status instead.
Policy > Networking > Networking Profiles > Global Gateway Configuration Update the global configuration
Deprecated: This rest routine is deprecated. Use /infra/connectivity-global-config for Connectivity global config and
/infra/ops-global-config for Operations global config.
Policy > Security > East West Security > Distributed Firewall > Communication Maps Revise the positioning of communication maps
Deprecated: This API is deprecated. Please use the following API instead.
POST /infra/domains/domain-id/security-policies/security-policy-id?action=revise
Policy > Security > East West Security > Distributed Firewall > Communication Maps Delete CommunicationEntry
Deprecated: This API is deprecated. Please use the following API instead.
DELETE /infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id
Policy > Security > East West Security > Distributed Firewall > Communication Maps Read CommunicationEntry
Deprecated: This API is deprecated. Please use the following API instead.
GET /infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id
Policy > Security > East West Security > Distributed Firewall > Communication Maps Patch a CommunicationEntry
Deprecated: This API is deprecated. Please use the following API instead.
PATCH /infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id
Policy > Security > East West Security > Distributed Firewall > Communication Maps Revise the positioning of communication entry
Deprecated: This API is deprecated. Please use the following API instead.
POST /infra/domains/domain-id/security-policies/security-policy-id/rules/rule-id?action=revise
Policy > Security > East West Security > Distributed Firewall > Communication Maps Create or update a CommunicationEntry
Deprecated: This API is deprecated. Please use the following API instead
PUT /infra/domains/domain-id/security-policies/securit-policy-id/rules/rule-id
Policy > Security > East West Security > Distributed Firewall > Settings > Exclusion List Read security policy exclude list including system and user excluded members
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store Invoke full sync or delta sync for a specific domain, with
additional delay in seconds if needed. Stop sync will try
to stop any pending sync if any to return to idle state.
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store Fetch all organization units for a Firewall Identity Store.
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store Get Firewall identity store sync statistics for the given identifier
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store List IDFW status for Transport Nodes in a Compute Collection
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server Delete a Event Log server for Firewall Identity store
Deprecated: Use the following Policy API - DELETE /infra/identity-firewall-stores/<identity-firewall-store-id>/event-log-servers/<event-log-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server Get a specific Event Log server for a given Firewall Identity store
Deprecated: Use the following Policy API - GET /infra/identity-firewall-stores/<identity-firewall-store-id>/event-log-servers/<event-log-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server Update a event log server for Firewall Identity store
Deprecated: Use the following Policy API - PUT /infra/identity-firewall-stores/<identity-firewall-store-id>/event-log-servers/<event-log-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server Delete a Event Log server for Firewall Identity store
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server Get a specific Event Log server for a given Firewall Identity store
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Event-Log-Server Update a event log server for Firewall Identity store
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Groups Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Groups List group's all direct and grand parent groups
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Groups List user's all direct and grand parent groups
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > LDAP Servers Test a directory domain event log server connectivity
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > LDAP Servers Test a directory domain LDAP server connectivity
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > LDAP Servers Test a LDAP server connection for directory domain
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server List all configured domain LDAP servers
Deprecated: Use the following Policy API - GET /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server Delete a LDAP server for Firewall Identity store
Deprecated: Use the following Policy API - DELETE /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server Get a specific LDAP server for a given Firewall Identity store
Deprecated: Use the following Policy API - GET /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server Create a LDAP server for Firewall Identity store
Deprecated: Use the following Policy API - PATCH /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server Update a LDAP server for Firewall Identity store
Deprecated: Use the following Policy API - PUT /infra/identity-firewall-stores/<identity-firewall-store-id>/ldap-servers/<ldap-server-id>
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server List all configured domain LDAP servers
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server Delete a LDAP server for Firewall Identity store
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server Get a specific LDAP server for a given Firewall Identity store
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server Create a LDAP server for Firewall Identity store
Policy > Security > East West Security > Distributed Firewall > Settings > Firewall Identity Store > Ldap-Server Update a LDAP server for Firewall Identity store
Policy > Security > North South Security > Gateway Firewall > Tier-0 Gateways Get list of gateway policies with rules that belong
to the specific Tier-0 logical router.
Policy > Security > North South Security > Gateway Firewall > Tier-0 Gateways Get list of gateway policies with rules that belong
to the specific Tier-0 LocalServices.
Policy > Security > North South Security > Gateway Firewall > Tier-1 Gateways Get list of gateway policies with rules that belong to the specific Tier-1.
Policy > Security > North South Security > Gateway Firewall > Tier-1 Gateways Get list of gateway policies with rules that belong
to the specific Tier-1 LocalServices.
Policy > Security > Service Insertion > Settings > Exclusion List Default API to read service insertion exclude list with system owned members filtered out
Policy > Security > Service Insertion > Settings > Exclusion List Additional API to read service insertion exclude list without filtering out the system owned members
Policy > VPC > Network Services > Load Balancing > Load Balancer Virtual Servers Delete LBVirtualServer and all the entities contained by this LBVirtualServer.
System Administration > Configuration > Avi Load Balancer > Controller > Alb Onboarding Workflow 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.
System Administration > Configuration > Avi Load Balancer > Controller > Alb Onboarding Workflow Delete Avi EnforcementPoint and the Infra Admin credentials contained by this workflow.
System Administration > Configuration > Avi Load Balancer > Controller > Alb Portal Certificate Install and update portal certificate in Avi Load Balancer Controller.
System Administration > Configuration > Avi Load Balancer > Controller > Alb System Config Update DNS, NTP and Backup server config in Avi Load Balancer Controller.
System Administration > Configuration > Avi Load Balancer > Controller > Alb User Credential Create service user object credential in Avi Load Balancer Controller cluster.
System Administration > Configuration > Avi Load Balancer > Controller > Alb User Credential Update admin user or service user object password in Avi Load Balancer Controller.
System Administration > Configuration > Avi Load Balancer > Controller > Alb User Credential Delete user credential from Avi Load Balancer Controller cluster.
System Administration > Configuration > Avi Load Balancer > Controller > Cluster Config Delete the cluster configuration for the Avi Load Balancer Controller cluster configuration. If Avi Load Balancer Controllers are present delete will fail.
System Administration > Configuration > Avi Load Balancer > Controller > Cluster Config Returns info for of the cluster configuration for the Avi Load Balancer Controller cluster
System Administration > Configuration > Avi Load Balancer > Controller > Cluster Config 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.
System Administration > Configuration > Avi Load Balancer > Controller > Deployments Returns info for all Avi Load Balancer cluster node auto-deployment attempts
System Administration > Configuration > Avi Load Balancer > Controller > Deployments Returns info for a Avi Load Balancer Controller deployment attempt
System Administration > Configuration > Avi Load Balancer > Controller > Deployments Attempt to delete an auto-deployed Avi Load Balancer Controller node
System Administration > Configuration > Avi Load Balancer > Controller > Deployments 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
System Administration > Configuration > Fabric > Cloud Native Service Instances Returns information about a particular cloud native service instance
by external-id.
System Administration > Configuration > Fabric > Compute Collections Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.
System Administration > Configuration > Fabric > Compute Collections Get status of member host nodes of the compute-collection. Only nsx prepared host nodes in the specified compute-collection are included in the response. cc-ext-id should be of type VC_Cluster.
System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters Relocate service contexts from edge and remove edge node from the edge-cluster
Deprecated: This API is deprecated. Please use POST /infra/sites//enforcement-points//edge-clusters//action/relocate-and-remove-edge-transport-node instead.
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Async Replicator Service Restart, start or stop the Async Replicator service
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Controller Service Get the status (Enabled/Disabled) of controller profiler
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Corfu Nonconfig Server Read the Corfu Nonconfig Server service properties
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Corfu Nonconfig Server Read the Corfu Nonconfig Server service status
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Corfu Server Get the status of Corfu Certificate Expiry Check. Enabled or disabled
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Corfu Server Restart, start or stop the Corfu Nonconfig Server service
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Dispatcher Service Restart, start or stop the NSX Edge Dispatcher service
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Idps Reporting Service Restart, start or stop the idps-reporting service
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Install Upgrade Service Restart, start or stop the NSX install-upgrade service
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Migration Coordinator Service Restart, start or stop the migration coordinator service
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > NSX Control Plane Agent Service Restart, start or stop the NSX Control Plane Agent service
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > NSX Control Plane Agent Service Read NSX Control Plane Agent service status
System Administration > Configuration > Fabric > Nodes > Transport Node Collections Move host from one sub-cluster to another sub-cluster.
When a node is moved from one sub-cluster to another sub-cluster, based on the
TransportNodeCollection configuration appropriate sub-configuration will be applied to the node. If
TransportNodeCollection does not have sub-configurations for the sub-cluster, then global configuration
will be applied.
System Administration > Configuration > Fabric > Nodes > Transport Node Collections Create transport node collection by attaching Transport Node Profile to cluster.
System Administration > Configuration > Fabric > Nodes > Transport Node Collections Create transport node collection by attaching Transport Node Profile to cluster.
System Administration > Configuration > Fabric > Nodes > Transport Node Status Read status of all transport nodes with tunnel connections to transport node
System Administration > Configuration > Fabric > Nodes > Transport Node Status Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.
System Administration > Configuration > Fabric > Nodes > Transport Node Status Creates a status json report of transport nodes of all the transport zones
System Administration > Configuration > Fabric > Nodes > Transport Nodes List Transport Nodes
Deprecated: This API is deprecated.
For Edge TN, Please use GET /infra/sites//enforcement-points//edge-transport-nodes instead.
For Host TN, Please use GET /infra/sites//enforcement-points//host-transport-nodes instead.
System Administration > Configuration > Fabric > Nodes > Transport Nodes Create a Transport Node
Deprecated: This API is deprecated.
For Edge TN, Please use PATCH/PUT /infra/sites//enforcement-points//edge-transport-nodes/ instead.
For Host TN, Please use PATCH/PUT /infra/sites//enforcement-points//host-transport-nodes/ instead.
System Administration > Configuration > Fabric > Nodes > Transport Nodes Get the module details of a transport node
Deprecated: This api is now deprecated. Please use new api -
/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>/modules
System Administration > Configuration > Fabric > Nodes > Transport Nodes Delete a Transport Node
Deprecated: This API is deprecated.
For Edge TN, Please use DELETE /infra/sites//enforcement-points//edge-transport-nodes/ instead.
For Host TN, Please use DELETE /infra/sites//enforcement-points//host-transport-nodes/ instead.
System Administration > Configuration > Fabric > Nodes > Transport Nodes Get a Transport Node
Deprecated: This API is deprecated.
For Edge TN, Please use GET /infra/sites//enforcement-points//edge-transport-nodes/ instead.
For Host TN, Please use GET /infra/sites//enforcement-points//host-transport-nodes/ instead.
System Administration > Configuration > Fabric > Nodes > Transport Nodes Apply cluster level Transport Node Profile on overridden host
Deprecated: This api is now deprecated. Please use new api - /infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>?action=restore_cluster_config
System Administration > Configuration > Fabric > Nodes > Transport Nodes Update a Transport Node
Deprecated: This API is deprecated.
For Edge TN, Please use PATCH/PUT /infra/sites//enforcement-points//edge-transport-nodes/ instead.
For Host TN, Please use PATCH/PUT /infra/sites//enforcement-points//host-transport-nodes/ instead.
System Administration > Configuration > Fabric > Nodes > Transport Nodes Get a Transport Node's State
Deprecated: This API is deprecated.
For Edge TN, Please use GET /infra/sites//enforcement-points//edge-transport-nodes//state instead.
For Host TN, Please use GET /infra/sites//enforcement-points//host-transport-nodes//state instead.
System Administration > Configuration > Fabric > Nodes > Transport Nodes Update transport node maintenance mode
Deprecated: This API is deprecated.
For Edge TN,
1. To put into maintenance mode, Please use POST /infra/sites//enforcement-points//edge-transport-nodes//action/enter-maintenance-mode instead.
2. To exit from the maintenance mode, Please use POST /infra/sites//enforcement-points//edge-transport-nodes//action/exit-maintenance-mode instead.
For Host TN, Please use POST /infra/sites//enforcement-points//host-transport-nodes/?action= instead.
System Administration > Configuration > Fabric > Nodes > Transport Nodes List transport nodes by realized state
Deprecated: This API is deprecated.
For Edge TN, Please use GET /infra/sites//enforcement-points///state instead.
For Host TN, Please use GET /infra/sites//enforcement-points///state instead.
System Administration > Configuration > Fabric > Transport Zones List Transport Zones
Deprecated: This api is now deprecated. Please use new api -
/policy/api/v1/infra/sites/<site-id>/enforcement-points/
<enforcementpoint-id>/transport-zones
System Administration > Configuration > Fabric > Transport Zones Create a Transport Zone
Deprecated: This api is now deprecated. Please use new api -
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-
id>/transport-zones/<zone-id>
System Administration > Configuration > Fabric > Transport Zones Delete a Transport Zone
Deprecated: This api is now deprecated. Please use new api -
DELETE /infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones/<zone-id>
System Administration > Configuration > Fabric > Transport Zones Get a Transport Zone
Deprecated: This api is now deprecated. Please use new api -
/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-
id>/transport-zones/<zone-id>
System Administration > Configuration > Fabric > Transport Zones Get high-level summary of a transport zone. The service layer does not support source = realtime or cached.
System Administration > Configuration > Global Configurations List global configurations of a NSX domain
Deprecated: The list API is disaggregated to feature verticals. Use the following Policy APIs for different global configs - OperationCollectorGlobalConfig GET /policy/api/v1/infra/ops-global-config RoutingGlobalConfig GET /policy/api/v1/infra/connectivity-global-config SecurityGlobalConfig GET /policy/api/v1/infra/security-global-config IdsGlobalConfig GET /policy/api/v1/infra/settings/firewall/security/intrusion-services FipsGlobalConfig GET /policy/api/v1/infra/connectivity-global-config SwitchingGlobalConfig GET /policy/api/v1/infra/connectivity-global-config FirewallGlobalConfig GET policy/api/v1/infra/settings/firewall/security
System Administration > Configuration > Global Configurations Get global configs for a config type
Deprecated: Use the following Policy APIs for different global configs - OperationCollectorGlobalConfig GET /policy/api/v1/infra/ops-global-config RoutingGlobalConfig GET /policy/api/v1/infra/connectivity-global-config SecurityGlobalConfig GET /policy/api/v1/infra/security-global-config IdsGlobalConfig GET /policy/api/v1/infra/settings/firewall/security/intrusion-services FipsGlobalConfig GET /policy/api/v1/infra/connectivity-global-config SwitchingGlobalConfig GET /policy/api/v1/infra/connectivity-global-config FirewallGlobalConfig GET policy/api/v1/infra/settings/firewall/security
System Administration > Configuration > Global Configurations Update global configurations of a config type
Deprecated: Use the following Policy APIs for different global configs - OperationCollectorGlobalConfig PUT /policy/api/v1/infra/ops-global-config RoutingGlobalConfig PUT /policy/api/v1/infra/connectivity-global-config SecurityGlobalConfig PUT /policy/api/v1/infra/security-global-config IdsGlobalConfig PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services FipsGlobalConfig PUT /policy/api/v1/infra/connectivity-global-config SwitchingGlobalConfig PUT /policy/api/v1/infra/connectivity-global-config FirewallGlobalConfig PUT /policy/api/v1/infra/settings/firewall/security
System Administration > Configuration > Global Configurations Resyncs global configurations of a config-type
Deprecated: Use the following Policy APIs for different global configs - OperationCollectorGlobalConfig PUT /policy/api/v1/infra/ops-global-config RoutingGlobalConfig PUT /policy/api/v1/infra/connectivity-global-config SecurityGlobalConfig PUT /policy/api/v1/infra/security-global-config IdsGlobalConfig PUT /policy/api/v1/infra/settings/firewall/security/intrusion-services FipsGlobalConfig PUT /policy/api/v1/infra/connectivity-global-config SwitchingGlobalConfig PUT /policy/api/v1/infra/connectivity-global-config FirewallGlobalConfig PUT /policy/api/v1/infra/settings/firewall/security
System Administration > Configuration > NSX Intelligence > Repository > Bundles Get list of bundle-ids which are available in repository or in-progress
System Administration > Configuration > NSX Managers > API Services > API Request Batching Register a Collection of API Calls at a Single End Point
Deprecated: 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.
System Administration > Configuration > NSX Managers > Clusters > Cluster Node Deployments Returns info for all cluster node VM auto-deployment attempts
System Administration > Lifecycle Management > Backup Restore Management > Restore List resources for a given instruction, to be
shown to/executed by users.
System Administration > Lifecycle Management > Upgrade > Bundles Lists the supported releases , available on VMware Download site to upgrade current system.
System Administration > Monitoring > Dashboards > Capacity Dashboard Updates the warning threshold(s) for NSX Objects.
Deprecated: MP objects are not supported in 9.0. Use
/api/v1/infra/capacity/thresholds to configure POLICY and FABRIC entities'
capacity warning thresholds.
System Administration > Monitoring > Dashboards > Widget Configuration Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.
Deprecated: This API is deprecated and will be unavailable in later releases.
System Administration > Monitoring > Health Checks Get an automatic health check
Deprecated: This API is deprecated. Please use policy API
/infra/auto-health-checks?transport_zone_path=<transport-zone-path>
to get an automatic health check for a specific transport zone.
System Administration > Monitoring > Health Checks List manual health checks
Deprecated: This API is deprecated. Please use policy API
/infra/manual-health-checks to list all the manual health check config entities;
/infra/manual-health-checks/<manual-health-check-id>/result to get result for
the specified manual health check ID.
System Administration > Monitoring > Health Checks Create a new manual health check request
Deprecated: This API is deprecated. Please use policy API
/infra/manual-health-checks/<manual-health-check-id>
to create a new manual health check request.
System Administration > Monitoring > Health Checks Delete an existing manual health check
Deprecated: This API is deprecated. Please use policy API
/infra/manual-health-checks/<manual-health-check-id>
to delete an existing manual health check.
System Administration > Service Insertion Get all service attachments.
Deprecated: This API has been deprecated, please use below Policy API For North-South service insertion GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces For East-West service insertion GET /policy/api/v1/infra/segments/service-segments
System Administration > Service Insertion Add a Service Attachment.
Deprecated: This API has been deprecated, please use below Policy API For North-South service insertion PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> For East-West service insertion PUT /policy/api/v1/infra/segments/service-segments/<service-segment-id> PATCH /policy/api/v1/infra/segments/service-segments/<service-segment-id>
System Administration > Service Insertion Delete an existing service attachment
Deprecated: This API has been deprecated, please use below Policy API For North-South service insertion DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> For East-West service insertion DELETE /policy/api/v1/infra/segments/service-segments/>service-segment-id>
System Administration > Service Insertion Get a particular service attachment.
Deprecated: This API has been deprecated, please use below Policy API For North-South service insertion GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> For East-West service insertion GET /policy/api/v1/infra/segments/service-segments/<service-segment-id>
System Administration > Service Insertion Update an existing service attachment.
Deprecated: This API has been deprecated, please use below Policy API For North-South service insertion PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id> For East-West service insertion PUT /policy/api/v1/infra/segments/service-segments/<service-segment-id> PATCH /policy/api/v1/infra/segments/service-segments/<service-segment-id>
System Administration > Service Insertion Add Service Chain
Deprecated: This API has been deprecated, please use below Policy API PUT /policy/api/v1/infra/service-chains/<service-chain-id> PATCH /policy/api/v1/infra/service-chains/<ervice-chain-id>
System Administration > Service Insertion Delete a Service Chain.
Deprecated: This API has been deprecated, for East-West service insertion and service chaining at the edge, please use below Policy API DELETE /policy/api/v1/infra/service-chains/<service-chain-id>
System Administration > Service Insertion Update an existing Service Deployment
Deprecated: This API is deprecated since only property we can change on service deployment
is display name, which is used for the SVM name. Changing the name will
cause the name of the deployment to go out of sync with the deployed VM.
System Administration > Service Insertion Delete an existing Service-Instance
Deprecated: This API has been deprecated, please use below Policy API DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id> DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
System Administration > Service Insertion Update an existing Service-Instance.
Deprecated: This API has been deprecated, please use below Policy API PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id> PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
System Administration > Service Insertion Add an InstanceEndpoint for a Service Instance
Deprecated: This API has been deprecated, please use below Policy API PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id> PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id> PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id> PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
System Administration > Service Insertion Delete a particular InstanceEndpoint.
Deprecated: This API has been deprecated, please use below Policy API DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id> DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id>
System Administration > Service Insertion Get a particular instance endpoint for a service instance.
Deprecated: This API has been deprecated, for North-South service insertion please use below Policy API GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id> GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/byod-service-instances/<service-instance-id>/service-instance-endpoints/<service-instance-endpoint-id&ggit;
System Administration > Service Insertion Deploy and set up service VMs either as standalone or HA
Deprecated: This API has been deprecated, please use below Policy API PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id> PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
System Administration > Service Insertion Upgrade service VMs using newer version of OVF
Deprecated: This API has been deprecated, please use below Policy API PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id> PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
System Administration > Service Insertion Remove service VMs either as standalone or HA
Deprecated: This API has been deprecated, please use below Policy API DELETE /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id> DELETE /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>
System Administration > Service Insertion Get statistics for a given interface identified by the interface index
Deprecated: This API has been deprecated, please use below Policy API GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>/statistics GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/service-instances/<service-instance-id>/statistics
System Administration > Service Insertion List all Service Profiles of a Service.
Deprecated: This API has been deprecated, please use below Policy API GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles
System Administration > Service Insertion Add ServiceProfile for a given Service.
Deprecated: This API has been deprecated, please use below Policy API PUT /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id> PATCH /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>
System Administration > Service Insertion Delete a particular ServiceProfile.
Deprecated: This API has been deprecated, please use below Policy API DELETE /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>
System Administration > Service Insertion Get a particular ServiceProfile for a Service.
Deprecated: This API has been deprecated, please use below Policy API GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>
System Administration > Service Insertion Get NSgroups for a given ServiceProfile.
Deprecated: This API has been deprecated, for East-West service insertion and chaining at the edge, please use below Policy API GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>/group-associations
System Administration > Service Insertion List all ServiceChainMappings.
Deprecated: This API has been deprecated, for East-West service insertion and service chaining at the edge, please use below Policy API GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>/service-chain-mappings
System Administration > Settings > Certificates > CRL Update CrlDistributionPoint with <crl-distribution-point-id>
This allows updating the ManagedResource fields.
System Administration > Settings > Certificates > Certificate Set a certificate as a GM or LM Principal Identity certificate
Deprecated: Please use below APIs. POST https://<nsx-mgr>/api/v1/trust-management/certificates/<cert-id>?action=apply_certificate&service_type=LOCAL_MANAGER POST https://<nsx-mgr>/api/v1/trust-management/certificates/<cert-id>?action=apply_certificate&service_type=GLOBAL_MANAGER
System Administration > Settings > Certificates > Certificate Set a certificate as the Appliance Proxy certificate to be used in inter-site communication
Deprecated: Please use below APIs. POST https://<nsx-mgr>/api/v1/trust-management/certificates/<cert-id>?action=apply_certificate&service_type=APH
System Administration > Settings > User Management > Principal Identity Return the list of token-based principal identities. | These don't have certificate or role information.
System Administration > Settings > User Management > VIDM Configuration Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the group of interest more characters need to be entered.
Deprecated: vIDM is deprecated by vIDB. Use API POST /api/v1/trust-management/oidc-uris/{id}/search.
System Administration > Settings > User Management > VIDM Configuration Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user/group of interest more characters need to be entered.
Deprecated: vIDM is deprecated by vIDB. Use API POST /api/v1/trust-management/oidc-uris/{id}/search.
System Administration > Settings > User Management > VIDM Configuration Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.
Deprecated: vIDM is deprecated by vIDB. Use API POST /api/v1/trust-management/oidc-uris/{id}/search.