NSX-T Data Center Global Manager REST API

Deprecated Methods

The following API methods are deprecated in this version. Deprecated methods continue to function, but may be removed in a future NSX version. Each deprecated method's documentation will advise what new method should be called instead of the deprecated method.

API Description API Path
Federation > Inter-Sites
Get infra segment cross site traffic statistics

Deprecated: This API is deprecated. Please use GET /infra/segments//inter-site-forwarder/stats instead. 		GET /global-manager/api/v1/global-infra/segments/{segment-id}/inter-site-forwarder/status (Deprecated)
Federation > Inter-Sites
Get segment cross site traffic statistics

Deprecated: This API is deprecated. Please use GET /infra/tier-1s//segments//inter-site-forwarder/stats instead. 		GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/inter-site-forwarder/status (Deprecated)
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 . 		GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/logical-ports (Deprecated)
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. 		GET /global-manager/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/members/logical-switches (Deprecated)
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 		PATCH /global-manager/api/v1/global-infra/context-profiles/custom-attributes (Deprecated)
Policy > Inventory > Profiles > Context Profiles
Adds/Removes custom attribute values from list

Deprecated: This rest routine is deprecated. Use /infra/context-profiles/custom-attributes/default to Adds/Removes custom attribute values from list 		POST /global-manager/api/v1/global-infra/context-profiles/custom-attributes (Deprecated)
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. 		PATCH /global-manager/api/v1/global-infra/traceflows/{traceflow-id} (Deprecated)
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. 		POST /global-manager/api/v1/global-infra/traceflows/{traceflow-id} (Deprecated)
Policy > Networking > Connectivity > Tier-0 Gateways > ARP Proxies
Get Tier-0 Address Resolution Protocol Proxies

Deprecated: This API is deprecated. Please use /infra/tier-0s/<tier-0-id>/arp-proxies 		GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/arp-proxies (Deprecated)
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 		GET /global-manager/api/v1/global-infra/segments/{segment-id}/gateway-interface-arp-table (Deprecated)
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 		GET /global-manager/api/v1/global-infra/segments/{segment-id}/gateway-interface-arp-table?format=csv (Deprecated)
Policy > Networking > Connectivity > Tier-1 Gateways > ARP Proxies
Get Tier-1 Address Resolution Protocol Proxies

Deprecated: This API is deprecated. Please use /infra/tier-1s/<tier-1-id>/arp-proxies Returns ARP proxy table for a tier-1 		GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies (Deprecated)
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 		GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table (Deprecated)
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 		GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table?format=csv (Deprecated)
Policy > Security > North South Security > Gateway Firewall > Settings > Security Configuration
Delete security config

Deprecated: Use the following API PUT/PATCH /infra/tier-0s//security-config 		DELETE /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/security-config (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > HTTP Service
Update http service certificate

Deprecated: Please use below APIs.
POST https://<nsx-mgr>/api/v1/trust-management/certificates/?action=apply_certificate&service_type=API&node_id=		 POST /api/v1/cluster/{cluster-node-id}/node/services/http?action=apply_certificate (Deprecated)
POST /api/v1/node/services/http?action=apply_certificate (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Telemetry Service
Read Telemetry service properties

Deprecated: This API is deprecated. Use:
GET https://<nsx-mgr>/api/v1/node/services/monitoring		 GET /api/v1/cluster/{cluster-node-id}/node/services/telemetry (Deprecated)
GET /api/v1/node/services/telemetry (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Telemetry Service
Restart, start or stop Telemetry service

Deprecated: This API is deprecated. Use:
POST https://<nsx-mgr>/api/v1/node/services/monitoring?action=restart|start|stop		 POST /api/v1/cluster/{cluster-node-id}/node/services/telemetry?action=restart (Deprecated)
POST /api/v1/cluster/{cluster-node-id}/node/services/telemetry?action=start (Deprecated)
POST /api/v1/cluster/{cluster-node-id}/node/services/telemetry?action=stop (Deprecated)
POST /api/v1/node/services/telemetry?action=restart (Deprecated)
POST /api/v1/node/services/telemetry?action=start (Deprecated)
POST /api/v1/node/services/telemetry?action=stop (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Telemetry Service
Reset the logging levels to default values

Deprecated: This API is deprecated. Use:
POST https://<nsx-mgr>/api/v1/node/services/monitoring?action=reset-monitoring-logging-levels		 POST /api/v1/cluster/{cluster-node-id}/node/services/telemetry?action=reset-telemetry-logging-levels (Deprecated)
POST /api/v1/node/services/telemetry?action=reset-telemetry-logging-levels (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Telemetry Service
Update Telemetry service properties

Deprecated: This API is deprecated. Use:
PUT https://<nsx-mgr>/api/v1/node/services/monitoring		 PUT /api/v1/cluster/{cluster-node-id}/node/services/telemetry (Deprecated)
PUT /api/v1/node/services/telemetry (Deprecated)
System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Telemetry Service
Read Telemetry service status

Deprecated: This API is deprecated. Use:
GET https://<nsx-mgr>/api/v1/node/services/monitoring/status		 GET /api/v1/cluster/{cluster-node-id}/node/services/telemetry/status (Deprecated)
GET /api/v1/node/services/telemetry/status (Deprecated)
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.		 POST /global-manager/api/v1/batch (Deprecated)
System Administration > Configuration > NSX Managers > Clusters > Cluster Certificate
 POST /api/v1/cluster/api-certificate?action=clear_cluster_certificate (Deprecated)
System Administration > Configuration > NSX Managers > Clusters > Cluster Certificate
Set the cluster certificate

Deprecated: Please use below APIs.
POST https://<nsx-mgr>/api/v1/trust-management/certificates/?action=apply_certificate&service_type=MGMT_CLUSTER		 POST /api/v1/cluster/api-certificate?action=set_cluster_certificate (Deprecated)
System Administration > Lifecycle Management > Upgrade > Bundles
 POST /api/v1/upgrade/bundle?action=upload (Deprecated)
System Administration > Lifecycle Management > Upgrade > Nodes
 GET /api/v1/cluster/{cluster-node-id}/node/upgrade (Deprecated)
GET /api/v1/node/upgrade (Deprecated)
System Administration > Lifecycle Management > Upgrade > Plan
Start upgrade

Deprecated:
This rest routine is deprecated. Use /upgrade/plan?action=upgrade to start, retry or continue the upgrade.		 POST /api/v1/upgrade/plan?action=start (Deprecated)
System Administration > Lifecycle Management > Upgrade > Plan
Continue upgrade

Deprecated:
This rest routine is deprecated. Use /upgrade/plan?action=upgrade to start, retry or continue the upgrade.		 POST /api/v1/upgrade/plan?action=continue (Deprecated)
System Administration > Monitoring > Dashboards > UI Views
Returns the Views based on query criteria defined in ViewQueryParameters.

Deprecated: This API is deprecated and will be unavailable in later releases.		 GET /global-manager/api/v1/ui-views (Deprecated)
System Administration > Monitoring > Dashboards > UI Views
Creates a new View.

Deprecated: This API is deprecated and will be unavailable in later releases.		 POST /global-manager/api/v1/ui-views (Deprecated)
System Administration > Monitoring > Dashboards > UI Views
Delete View

Deprecated: This API is deprecated and will be unavailable in later releases.		 DELETE /global-manager/api/v1/ui-views/{view-id} (Deprecated)
System Administration > Monitoring > Dashboards > UI Views
Returns View Information

Deprecated: This API is deprecated and will be unavailable in later releases.		 GET /global-manager/api/v1/ui-views/{view-id} (Deprecated)
System Administration > Monitoring > Dashboards > UI Views
Update View

Deprecated: This API is deprecated and will be unavailable in later releases.		 PUT /global-manager/api/v1/ui-views/{view-id} (Deprecated)
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.		 GET /global-manager/api/v1/ui-views/{view-id}/widgetconfigurations (Deprecated)
System Administration > Monitoring > Dashboards > Widget Configuration
Creates a new Widget Configuration.

Deprecated: This API is deprecated and will be unavailable in later releases.		 POST /global-manager/api/v1/ui-views/{view-id}/widgetconfigurations (Deprecated)
System Administration > Monitoring > Dashboards > Widget Configuration
Delete Widget Configuration

Deprecated: This API is deprecated and will be unavailable in later releases.		 DELETE /global-manager/api/v1/ui-views/{view-id}/widgetconfigurations/{widgetconfiguration-id} (Deprecated)
System Administration > Monitoring > Dashboards > Widget Configuration
Returns Widget Configuration Information

Deprecated: This API is deprecated and will be unavailable in later releases.		 GET /global-manager/api/v1/ui-views/{view-id}/widgetconfigurations/{widgetconfiguration-id} (Deprecated)
System Administration > Monitoring > Dashboards > Widget Configuration
Update Widget Configuration

Deprecated: This API is deprecated and will be unavailable in later releases.		 PUT /global-manager/api/v1/ui-views/{view-id}/widgetconfigurations/{widgetconfiguration-id} (Deprecated)
System Administration > Settings > Certificates > CRL
Return the list of CrlDistributionPoints

Deprecated: Do not use. This is currently unused functionality that will be removed.		 GET /api/v1/trust-management/crl-distribution-points (Deprecated)
System Administration > Settings > Certificates > CRL
Create a Crl Distribution Point

Deprecated: Do not use. This is currently unused functionality that will be removed.		 POST /api/v1/trust-management/crl-distribution-points (Deprecated)
System Administration > Settings > Certificates > CRL
Delete a CrlDistributionPoint

Deprecated: Do not use. This is currently unused functionality that will be removed.		 DELETE /api/v1/trust-management/crl-distribution-points/{crl-distribution-point-id} (Deprecated)
System Administration > Settings > Certificates > CRL
Return the CrlDistributionPoint with <crl-distribution-point-id>

Deprecated: Do not use. This is currently unused functionality that will be removed.		 GET /api/v1/trust-management/crl-distribution-points/{crl-distribution-point-id} (Deprecated)
System Administration > Settings > Certificates > CRL
Return the status of the CrlDistributionPoint

Deprecated: Do not use. This is currently unused functionality that will be removed.		 GET /api/v1/trust-management/crl-distribution-points/{crl-distribution-point-id}/status (Deprecated)
System Administration > Settings > Certificates > CRL
Return stored CRL in PEM format

Deprecated: Do not use. This is currently unused functionality that will be removed.		 POST /api/v1/trust-management/crl-distribution-points/pem-file (Deprecated)
System Administration > Settings > Certificates > CSR
Generate a New Certificate Signing Request with Extensions

Deprecated: Deprecated in favor of POST /trust-management/csrs. 		POST /api/v1/trust-management/csrs-extended (Deprecated)
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		 POST /api/v1/trust-management/certificates?action=set_pi_certificate_for_federation (Deprecated)
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		 POST /api/v1/trust-management/certificates?action=set_appliance_proxy_certificate_for_inter_site_communication (Deprecated)
System Administration > Settings > User Management > Access Token
Delete registration access token

Deprecated: Use API POST /api/v1/aaa/registration-token/delete		 DELETE /api/v1/aaa/registration-token/{token} (Deprecated)
System Administration > Settings > User Management > Access Token
Get registration access token

Deprecated: Use API POST /api/v1/aaa/registration-token/retrieve		 GET /api/v1/aaa/registration-token/{token} (Deprecated)
System Administration > Settings > User Management > Principal Identity
Register a name-certificate combination.

Deprecated: Deprecated, use POST /trust-management/principal-identities/with-certificate instead. 		POST /api/v1/trust-management/principal-identities (Deprecated)
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.		 GET /global-manager/api/v1/aaa/vidm/groups (Deprecated)
GET /api/v1/aaa/vidm/groups (Deprecated)
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.		 POST /global-manager/api/v1/aaa/vidm/search (Deprecated)
POST /api/v1/aaa/vidm/search (Deprecated)
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.		 GET /global-manager/api/v1/aaa/vidm/users (Deprecated)
GET /api/v1/aaa/vidm/users (Deprecated)
System Administration > Settings > User Management > VIDM Configuration
Read AAA provider vIDM properties

Deprecated: vIDM is deprecated by vIDB. Use API GET /api/v1/trust-management/oidc-uris/.		 GET /api/v1/cluster/{cluster-node-id}/node/aaa/providers/vidm (Deprecated)
GET /api/v1/node/aaa/providers/vidm (Deprecated)
System Administration > Settings > User Management > VIDM Configuration
Update AAA provider vIDM properties

Deprecated: vIDM is deprecated by vIDB. Use API POST /api/v1/trust-management/oidc-uris/action/configure-vidb-oidc-endpoint.		 PUT /api/v1/cluster/{cluster-node-id}/node/aaa/providers/vidm (Deprecated)
PUT /api/v1/node/aaa/providers/vidm (Deprecated)
System Administration > Settings > User Management > VIDM Configuration
Read AAA provider vIDM status

Deprecated: vIDM is deprecated by vIDB. Use API GET /api/v1/trust-management/oidc-uris/{id}/health.		 GET /api/v1/cluster/{cluster-node-id}/node/aaa/providers/vidm/status (Deprecated)
GET /api/v1/node/aaa/providers/vidm/status (Deprecated)