NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List DHCP server config instances Paginated list of all DHCP server config instances	GET /policy/api/v1/infra/dhcp-server-configs GET /policy/api/v1/global-infra/dhcp-server-configs GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs
Read DHCP server leases Read DHCP server leases	GET /policy/api/v1/infra/dhcp-server-configs/{config-id}/leases GET /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/leases GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/leases
Read DHCP server state Read DHCP server state	GET /policy/api/v1/infra/dhcp-server-configs/{config-id}/state GET /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/state GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/state
Read DHCP server statistics Read DHCP server statistics	GET /policy/api/v1/infra/dhcp-server-configs/{config-id}/stats GET /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/stats GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/stats
Reset DHCP server statistics counters Reset DHCP statistics counters of a DHCP server represented by the connectivity_path and the enforecement_point_path where the dhcp-server-config was applied to. The connectivity_path can be the Tier0 path, Tier1 path or a segment path. If the given Tier0/1 or Segment has DHCP server applied, the resetting will succeed and the DHCP statistics counters will be reset to 0. But if it has no DHCP server applied, the reseting will fail with proper error message.	POST /policy/api/v1/infra/dhcp-server-configs/{config-id}/stats?action=reset POST /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/stats?action=reset POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/stats?action=reset
Read DHCP server status Read DHCP server status	GET /policy/api/v1/infra/dhcp-server-configs/{config-id}/status GET /policy/api/v1/global-infra/dhcp-server-configs/{config-id}/status GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{config-id}/status
Delete DHCP server configuration Delete DHCP server configuration	DELETE /policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{dhcp-server-config-id}
Read DHCP server configuration Read DHCP server configuration	GET /policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id} GET /policy/api/v1/global-infra/dhcp-server-configs/{dhcp-server-config-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{dhcp-server-config-id}
Create or update DHCP server configuration If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, update the DHCP server config instance with specified attributes. Realized entities of this API can be found using the path of Tier-0, Tier1, or Segment where this config is applied on. Modification of edge_cluster_path in DhcpServerConfig will lose all existing DHCP leases. If both the preferred_edge_paths in the DhcpServerConfig are changed in a same PATCH API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause network connectivity issues. It is recommended to change only one member index in an update call, e.g. from [a, b] to [a,y]. Clearing preferred_edge_paths will not reassign edge nodes from the edge cluster. Instead, the previously-allocated edge nodes will be retained to avoid loss of leases.	PATCH /policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{dhcp-server-config-id}
Create or update DHCP server configuration If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, replace the DHCP server config instance with this object. Realized entities of this API can be found using the path of Tier-0, Tier1, or Segment where this config is applied on. Modification of edge_cluster_path in DhcpServerConfig will lose all existing DHCP leases. If both the preferred_edge_paths in the DhcpServerConfig are changed in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause network connectivity issues. It is recommended to change only one member index in an update call, e.g. from [a, b] to [a,y]. Clearing preferred_edge_paths will not reassign edge nodes from the edge cluster. Instead, the previously-allocated edge nodes will be retained to avoid loss of leases.	PUT /policy/api/v1/infra/dhcp-server-configs/{dhcp-server-config-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/dhcp-server-configs/{dhcp-server-config-id}