Associated URIs:

API Description	API Path
List All Bridge Clusters Returns information about all configured bridge clusters. ESXI host bridge cluster is deprecated and only Edge Bridge cluster is supported.	GET /api/v1/bridge-clusters (Deprecated)
Create a Bridge Cluster Creates a bridge cluster. It is collection of transport nodes that will do the bridging for overlay network to vlan networks. Bridge cluster may have one or more transport nodes. ESXI bridge cluster is deprecated and only Edge Bridge cluster is supported.	POST /api/v1/bridge-clusters (Deprecated)
Delete a Bridge Cluster Removes the specified Bridge Cluster. ESXI bridge cluster is deprecated and only Edge Bridge cluster is supported.	DELETE /api/v1/bridge-clusters/<bridgecluster-id> (Deprecated)
Get Information about a bridge cluster Returns information about a specified bridge cluster. ESXI bridge cluster is deprecated and only Edge Bridge cluster is supported.	GET /api/v1/bridge-clusters/<bridgecluster-id> (Deprecated)
Update a Bridge Cluster Modifies a existing bridge cluster. One of more transport nodes can be added or removed from the bridge cluster using this API. ESXI bridge cluster is deprecated and only Edge Bridge cluster is supported.	PUT /api/v1/bridge-clusters/<bridgecluster-id> (Deprecated)
Returns status of a specified Bridge Cluster Get the status for the Bridge Cluster of the given cluster id	GET /api/v1/bridge-clusters/<cluster-id>/status
List All Bridge Endpoint Profiles Returns information about all configured bridge endoint profiles	GET /api/v1/bridge-endpoint-profiles
Create a Bridge Endpoint Profile Creates a Bridge Endpoint Profile. Profile contains edge cluster id, indexes of the member nodes, fialover mode and high availability mode for a Bridge EndPoint	POST /api/v1/bridge-endpoint-profiles
Delete a Bridge Endpoint Profile Deletes the specified Bridge Endpoint Profile.	DELETE /api/v1/bridge-endpoint-profiles/<bridgeendpointprofile-id>
Get Information about a bridge endpoint Profile Returns information about a specified bridge endpoint profile.	GET /api/v1/bridge-endpoint-profiles/<bridgeendpointprofile-id>
Update a Bridge Endpoint Profile Modifies a existing bridge endpoint profile.	PUT /api/v1/bridge-endpoint-profiles/<bridgeendpointprofile-id>
List All Bridge Endpoints Returns information about all configured bridge endoints	GET /api/v1/bridge-endpoints
Create a Bridge Endpoint Creates a Bridge Endpoint. It describes the physical attributes of the bridge like vlan. A logical port can be attached to a vif providing bridging functionality from the logical overlay network to the physical vlan network	POST /api/v1/bridge-endpoints
Delete a Bridge Endpoint Deletes the specified Bridge Endpoint.	DELETE /api/v1/bridge-endpoints/<bridgeendpoint-id>
Get Information about a bridge endpoint Returns information about a specified bridge endpoint.	GET /api/v1/bridge-endpoints/<bridgeendpoint-id>
Update a Bridge Endpoint Modifies a existing bridge endpoint.	PUT /api/v1/bridge-endpoints/<bridgeendpoint-id>
Returns statistics of a specified Bridge Endpoint Get the statistics for the Bridge Endpoint of the given Endpoint id (endpoint-id)	GET /api/v1/bridge-endpoints/<endpoint-id>/statistics
Returns status of a specified Bridge Endpoint Get the status for the Bridge Endpoint of the given Endpoint id	GET /api/v1/bridge-endpoints/<endpoint-id>/status
List All DHCP Relay Profiles Returns information about all dhcp relay profiles.	GET /api/v1/dhcp/relay-profiles
Create a DHCP Relay Profile Creates a dhcp relay profile.	POST /api/v1/dhcp/relay-profiles
Delete a DHCP Relay Profile Deletes the specified dhcp relay profile.	DELETE /api/v1/dhcp/relay-profiles/<relay-profile-id>
Read a DHCP Relay Profile Returns information about the specified dhcp relay profile.	GET /api/v1/dhcp/relay-profiles/<relay-profile-id>
Update a DHCP Relay Profile Modifies the specified dhcp relay profile.	PUT /api/v1/dhcp/relay-profiles/<relay-profile-id>
List all DHCP Relay Services Returns information about all configured dhcp relay services.	GET /api/v1/dhcp/relays
Create a DHCP Relay Service Creates a dhcp relay service.	POST /api/v1/dhcp/relays
Delete a DHCP Relay Service Deletes the specified dhcp relay service.	DELETE /api/v1/dhcp/relays/<relay-id>
Read a DHCP Relay Service Returns the dhcp relay service information.	GET /api/v1/dhcp/relays/<relay-id>
Update a DHCP Relay Service Modifies the specified dhcp relay service.	PUT /api/v1/dhcp/relays/<relay-id>
Get a paginated list of DHCP server profiles Get a paginated list of DHCP server profiles.	GET /api/v1/dhcp/server-profiles
Create a DHCP server profile Create a DHCP server profile. If no edge member is specified, edge members to run the dhcp servers will be auto-allocated from the edge cluster.	POST /api/v1/dhcp/server-profiles
Delete a DHCP server profile Delete a DHCP server profile specified by the profile id.	DELETE /api/v1/dhcp/server-profiles/<profile-id>
Get a DHCP server profile Return the DHCP profile specified by the profile id.	GET /api/v1/dhcp/server-profiles/<profile-id>
Update a DHCP server profile If both the edge_cluster_member_indexes in the DhcpProfile 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 the network crash due to ip conflicts. Hence the suggestion is to change only one member index in one single update, e.g. from [a, b] to [a,y]. Please note, the edge_cluster_id in DhcpProfile can NOT be changed by this PUT operation because all existing DHCP leases will lost. If losing leases is not a problem, a dedicated re-allocation API is suggested to modify the edge-cluster-id, i.e. "POST /api/v1/dhcp/dhcp-profiles/?action=reallocate". Meanwhile, if the edge_cluster_member_indexes was specified currently but now is changed to none (not specified) via a PUT operation, the edge nodes will not be auto-selected from edge cluster. Instead, the previously-allocated edge nodes will continue to be used by the DHCP server. This is because changing both edge nodes of a DHCP server will lose all existing leases. In case re-allocation is required and leases lost is not a problem (or can be recovered), please invoke the reallocate API mentioned above with new DhcpProfile to accomplish the intent.	PUT /api/v1/dhcp/server-profiles/<profile-id>
Reallocate edge cluster and members of given DHCP profile. As changing edge-cluster-id of a DhcpProfile by a PUT is disallowed, this re-allocate API is used to modify the edge-cluster-id and members of a given DhcpProfile. Only the edge-cluster-id and the edge-cluster-member-indexes fields will be picked up by this re-allication API. The othere fields in the payload will be ignored. If the edge-cluster-id in the payload DhcpProfile is different from the current edge-cluster-id of the profile, the referencing DHCP server(s) will be re-allocated to the new edge cluster. If the edge-cluster-id is not changed, the referencing DHCP server(s) will be re-allocated to the given edge members in the edge cluster. In this case, this REST API will act same as that of updating a DhcpProfile. If the edge cluster member indexes are provided, they should exist in the given edge cluster. If the indexes are not specified in the DhcpProfile, edge members will be auto-allocated from the given edge cluster. Please note that re-allocating edge-cluster will cause lose of all exisitng DHCP lease information. This API is used only when loosing DHCP leases is not a real problem, e.g. cross-site migration or failover and all client hosts will be reboot and get new IP addresses.	POST /api/v1/dhcp/server-profiles/<server-profile-id>?action=reallocate
Get a paginated list of DHCP servers List logical DHCP servers with pagination support.	GET /api/v1/dhcp/servers
Create a DHCP server Create a logical DHCP server with v4 and/or v6 servers.	POST /api/v1/dhcp/servers
Delete a DHCP server Delete a logical DHCP server specified by server id.	DELETE /api/v1/dhcp/servers/<server-id>
Get a DHCP server with v4 and/or v6 servers Retrieve a logical DHCP server specified by server id.	GET /api/v1/dhcp/servers/<server-id>
Update a DHCP server with v4 and/or v6 servers Update a logical DHCP server with new configurations.	PUT /api/v1/dhcp/servers/<server-id>
Get a paginated list of a DHCP server's IP pools List the ip pools of a logical DHCP server with pagination support.	GET /api/v1/dhcp/servers/<server-id>/ip-pools
Create an ip pool for a DHCP server Create an ip pool for a local DHCP server	POST /api/v1/dhcp/servers/<server-id>/ip-pools
Delete a DHCP server's IP pool Delete a specific ip pool of a given logical DHCP server.	DELETE /api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id>
Get a DHCP server's IP pool with the specified pool ID Return a specific ip pool of a given logical DHCP server.	GET /api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id>
Update a DHCP server's IP pool Update a specific ip pool of a given logical DHCP server.	PUT /api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id>
Get the realized state of a dhcp ip pool Return realized state information of a dhcp ip pool. After a dhcp ip pool is created or updated, you can invoke this API to get the realization information of the ip pool.	GET /api/v1/dhcp/servers/<server-id>/ip-pools/<pool-id>/state
Get a paginated list of a DHCP IPv6 server's IP pools List the ip pools of a logical DHCP IPv6 server with pagination support.	GET /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools
Create an ip pool for a DHCP IPv6 server Create an ip pool for a local DHCP IPv6 server	POST /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools
Delete a DHCP IPv6 server's IP pool Delete a specific ip pool of a given logical DHCP IPv6 server.	DELETE /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools/<pool-id>
Get a DHCP IPv6 server's IP pool with the specified pool ID Return a specific ip pool of a given logical DHCP IPv6 server.	GET /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools/<pool-id>
Update a DHCP IPv6 server's IP pool Update a specific ip pool of a given logical DHCP IPv6 server.	PUT /api/v1/dhcp/servers/<server-id>/ipv6-ip-pools/<pool-id>
Get a paginated list of a DHCP IPv6 server's static bindings Return a paginated list of a static bindings of a given logical DHCP IPv6 server.	GET /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings
Create a static binding for a DHCP IPv6 server Create a static binding for a logical DHCP IPv6 server.	POST /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings
Delete a static binding for DHCP IPv6 server Delete a specific static binding of a given logical DHCP IPv6 server.	DELETE /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings/<binding-id>
Get a DHCP IPv6 server's static binding with the specified binding ID Return a specific static binding of a given logical DHCP IPv6 server.	GET /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings/<binding-id>
Update a DHCP IPv6 server's static binding Update a specific static binding of a given local DHCP IPv6 server.	PUT /api/v1/dhcp/servers/<server-id>/ipv6-static-bindings/<binding-id>
Delete a single DHCP lease entry specified by ip and mac. Delete a single DHCP lease entry specified by ip and mac. The DHCP server matches the DHCP lease with the given ip address and the mac address. The matched lease entry will be deleted. If no lease matches, the request is ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.	DELETE /api/v1/dhcp/servers/<server-id>/leases
Get the realized state of a dhcp server Return realized state information of a dhcp server. After a dhcp server is created or updated, you can invoke this API to get the realization information of the server.	GET /api/v1/dhcp/servers/<server-id>/state
Get a paginated list of a DHCP server's static bindings Return a paginated list of a static bindings of a given logical DHCP server.	GET /api/v1/dhcp/servers/<server-id>/static-bindings
Create a static binding for a DHCP server Create a static binding for a logical DHCP server.	POST /api/v1/dhcp/servers/<server-id>/static-bindings
Delete a static binding Delete a specific static binding of a given logical DHCP server.	DELETE /api/v1/dhcp/servers/<server-id>/static-bindings/<binding-id>
Get a DHCP server's static binding with the specified binding ID Return a specific static binding of a given logical DHCP server.	GET /api/v1/dhcp/servers/<server-id>/static-bindings/<binding-id>
Update a DHCP server's static binding Update a specific static binding of a given local DHCP server.	PUT /api/v1/dhcp/servers/<server-id>/static-bindings/<binding-id>
Get the realized state of a dhcp static binding Return realized state information of a dhcp static binding. After a dhcp static binding is created or updated, you can invoke this API to get the realization information of the static binding.	GET /api/v1/dhcp/servers/<server-id>/static-bindings/<binding-id>/state
Get DHCP service status with given dhcp server id Returns the service status of the given dhcp server.	GET /api/v1/dhcp/servers/<server-id>/status
Get a paginated list of DNS forwarders Get a paginated list of DNS forwarders.	GET /api/v1/dns/forwarders
Create a DNS forwader Create a DNS forwader upon a logical router. There is only one DNS forwarder can be created upon a given logical router.	POST /api/v1/dns/forwarders
Delete a specific DNS forwarder Delete a specific DNS forwarder.	DELETE /api/v1/dns/forwarders/<forwarder-id>
Retrieve a DNS forwarder Retrieve a DNS forwarder.	GET /api/v1/dns/forwarders/<forwarder-id>
Clear the current cache of the DNS forwarder. Clear the current cache of the DNS forwarder.	POST /api/v1/dns/forwarders/<forwarder-id>?action=clear_cache
Enable the DNS forwarder. Enable the DNS forwarder if the forwarder is currently disabled. If the DNS forwarder is already enabled, the forwarder will not be re-enabled. Please note, once a DNS forwarder is disabled then enabled, the previous DNS forwarder statistics counters will be reset.	POST /api/v1/dns/forwarders/<forwarder-id>?action=enable
Disable the DNS forwarder. Disable the DNS forwarder if the forwarder is currently enbled. If the DNS forwarder is already disabled, the forwarder will not be re-disabled. Please note, once a DNS forwarder is disabled then enabled, the previous DNS forwarder statistics counters will be reset.	POST /api/v1/dns/forwarders/<forwarder-id>?action=disable
Update a specific DNS forwarder Update a specific DNS forwarder.	PUT /api/v1/dns/forwarders/<forwarder-id>
Get the recent failed DNS queries Return the given count of recent failed DNS queries from DNS forwarder. Since the DNS forwarder is running in Acitve/Standby HA mode on transport nodes, the given count of queries will be returned from each nodes. Hence the total queries returned could be doubled. If no count is specified, 100 recent failed queries are returned. If the recent failures is less than the given count, all the failures will be returned. The maximum count is 1,000.	GET /api/v1/dns/forwarders/<forwarder-id>/failed-queries
Resolve a given address via the DNS forwarder Query the nameserver for an ip-address or a FQDN of the given an address optionally using an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it. If the address is an ip-address, do a reverse lookup and answer fqdn(s).	GET /api/v1/dns/forwarders/<forwarder-id>/nslookup
Get the realized state of a DNS forwarder Return the realized state information of a DNS forwarder. After a DNS forwarder was created or updated, you can invoke this API to check the realization state of the forwarder.	GET /api/v1/dns/forwarders/<forwarder-id>/state
Get current status of the given DNS forwarder Returns the current status of the given DNS forwarder.	GET /api/v1/dns/forwarders/<forwarder-id>/status
Read All IPV6 DADProfiles Returns all IPv6 DADProfiles.	GET /api/v1/ipv6/dad-profiles
Create a new DADProfile Adds a new DADProfile	POST /api/v1/ipv6/dad-profiles
Delete DAD Profile Delete DADProfile	DELETE /api/v1/ipv6/dad-profiles/<dad-profile-id>
Read specified IPV6 DADProfile Returns information about specified IPv6 DADProfile.	GET /api/v1/ipv6/dad-profiles/<dad-profile-id>
Update DADProfile Update DADProfile.	PUT /api/v1/ipv6/dad-profiles/<dad-profile-id>
Read All IPV6 NDRA Profiles Returns all IPv6 NDRA Profiles.	GET /api/v1/ipv6/nd-ra-profiles
Create a new NDRA Profile Adds a new NDRAProfile	POST /api/v1/ipv6/nd-ra-profiles
Delete NDRA Profile Delete NDRAProfile	DELETE /api/v1/ipv6/nd-ra-profiles/<nd-ra-profile-id>
Read specified IPV6 NDRA Profile Returns information about specified IPv6 NDRA Profile.	GET /api/v1/ipv6/nd-ra-profiles/<nd-ra-profile-id>
Update NDRA Profile Update NDRAProfile	PUT /api/v1/ipv6/nd-ra-profiles/<nd-ra-profile-id>
Retrieve a paginated list of load balancer application profiles Retrieve a paginated list of load balancer application profiles.	GET /api/v1/loadbalancer/application-profiles
Create a load balancer application profile Create a load balancer application profile.	POST /api/v1/loadbalancer/application-profiles
Delete a load balancer application profile Delete a load balancer application profile.	DELETE /api/v1/loadbalancer/application-profiles/<application-profile-id>
Retrieve a load balancer application profile Retrieve a load balancer application profile.	GET /api/v1/loadbalancer/application-profiles/<application-profile-id>
Update a load balancer application profile Update a load balancer application profile.	PUT /api/v1/loadbalancer/application-profiles/<application-profile-id>
Retrieve a paginated list of load balancer client-ssl profiles Retrieve a paginated list of load balancer client-ssl profiles.	GET /api/v1/loadbalancer/client-ssl-profiles
Create a load balancer client-ssl profile Create a load balancer client-ssl profile.	POST /api/v1/loadbalancer/client-ssl-profiles
Delete a load balancer client-ssl profile Delete a load balancer client-ssl profile.	DELETE /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id>
Retrieve a load balancer client-ssl profile Retrieve a load balancer client-ssl profile.	GET /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id>
Update a load balancer client-ssl profile Update a load balancer client-ssl profile.	PUT /api/v1/loadbalancer/client-ssl-profiles/<client-ssl-profile-id>
Retrieve a paginated list of load balancer monitors Retrieve a paginated list of load balancer monitors.	GET /api/v1/loadbalancer/monitors
Create a load balancer monitor Create a load balancer monitor.	POST /api/v1/loadbalancer/monitors
Delete a load balancer monitor Delete a load balancer monitor.	DELETE /api/v1/loadbalancer/monitors/<monitor-id>
Retrieve a load balancer monitor Retrieve a load balancer monitor.	GET /api/v1/loadbalancer/monitors/<monitor-id>
Update a load balancer monitor Update a load balancer monitor.	PUT /api/v1/loadbalancer/monitors/<monitor-id>
Read load balancer node usage summary API is used to retrieve the load balancer node usage summary for all nodes.	GET /api/v1/loadbalancer/node-usage-summary
Retrieve a paginated list of load balancer persistence profiles Retrieve a paginated list of load balancer persistence profiles.	GET /api/v1/loadbalancer/persistence-profiles
Create a load balancer persistence profile Create a load balancer persistence profile.	POST /api/v1/loadbalancer/persistence-profiles
Delete a load balancer persistence profile Delete a load balancer persistence profile.	DELETE /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id>
Retrieve a load balancer persistence profile Retrieve a load balancer persistence profile.	GET /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id>
Update a load balancer persistence profile Update a load balancer persistence profile.	PUT /api/v1/loadbalancer/persistence-profiles/<persistence-profile-id>
Retrieve a paginated list of load balancer pools Retrieve a paginated list of load balancer pools.	GET /api/v1/loadbalancer/pools
Create a load balancer pool Create a load balancer pool.	POST /api/v1/loadbalancer/pools
Delete a load balancer pool Delete a load balancer pool.	DELETE /api/v1/loadbalancer/pools/<pool-id>
Retrieve a load balancer pool Retrieve a load balancer pool.	GET /api/v1/loadbalancer/pools/<pool-id>
Add, remove, or modify load balancer pool members For ADD_MEMBERS, pool members will be created and added to load balancer pool. This action is only valid for static pool members. For REMOVE_MEMBERS, pool members will be removed from load balancer pool via IP and port in pool member settings. This action is only valid for static pool members. For UPDATE_MEMBERS, pool members admin state will be updated. This action is valid for both static pool members and dynamic pool members. For dynamic pool members, this update will be stored in customized_members field in load balancer pool member group.	POST /api/v1/loadbalancer/pools/<pool-id>
Update a load balancer pool Update a load balancer pool.	PUT /api/v1/loadbalancer/pools/<pool-id>
Retrieve a paginated list of load balancer rules Retrieve a paginated list of load balancer rules.	GET /api/v1/loadbalancer/rules
Create a load balancer rule Create a load balancer rule.	POST /api/v1/loadbalancer/rules
Delete a load balancer rule Delete a load balancer rule.	DELETE /api/v1/loadbalancer/rules/<rule-id>
Retrieve a load balancer rule Retrieve a load balancer rule.	GET /api/v1/loadbalancer/rules/<rule-id>
Update a load balancer rule Update a load balancer rule.	PUT /api/v1/loadbalancer/rules/<rule-id>
Retrieve a paginated list of load balancer server-ssl profiles Retrieve a paginated list of load balancer server-ssl profiles.	GET /api/v1/loadbalancer/server-ssl-profiles
Create a load balancer server-ssl profile Create a load balancer server-ssl profile.	POST /api/v1/loadbalancer/server-ssl-profiles
Delete a load balancer server-ssl profile Delete a load balancer server-ssl profile.	DELETE /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id>
Retrieve a load balancer server-ssl profile Retrieve a load balancer server-ssl profile.	GET /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id>
Update a load balancer server-ssl profile Update a load balancer server-ssl profile.	PUT /api/v1/loadbalancer/server-ssl-profiles/<server-ssl-profile-id>
Retrieve a paginated list of load balancer services Retrieve a paginated list of load balancer services. When logical_router_id is specified in request parameters, the associated load balancer services which are related to the given logical router returned.	GET /api/v1/loadbalancer/services
Create a load balancer service Create a load balancer service.	POST /api/v1/loadbalancer/services
Delete a load balancer service Delete a load balancer service.	DELETE /api/v1/loadbalancer/services/<service-id>
Retrieve a load balancer service Retrieve a load balancer service.	GET /api/v1/loadbalancer/services/<service-id>
Update a load balancer service Update a load balancer service.	PUT /api/v1/loadbalancer/services/<service-id>
Read the debug information of the load balancer service API to download below information which will be used for debugging and troubleshooting. 1) Load balancer service 2) Load balancer associated virtual servers 3) Load balancer associated pools 4) Load balancer associated profiles such as persistence, SSL, application. 5) Load balancer associated monitors 6) Load balancer associated rules	GET /api/v1/loadbalancer/services/<service-id>/debug-info
Get the statistics of load balancer pool Returns the statistics of the given load balancer pool by given load balancer serives id and load balancer pool id. Currently, only realtime mode is supported.	GET /api/v1/loadbalancer/services/<service-id>/pools/<pool-id>/statistics
Get the status of load balancer pool Returns the status of the given load balancer pool by given load balancer serives id and load balancer pool id.	GET /api/v1/loadbalancer/services/<service-id>/pools/<pool-id>/status
Get the statistics list of load balancer pools Returns the statistics list of load balancer pools in given load balancer service. Currently, only realtime mode is supported.	GET /api/v1/loadbalancer/services/<service-id>/pools/statistics
Get the status list of load balancer pools Returns the status list of load balancer pools in given load balancer service.	GET /api/v1/loadbalancer/services/<service-id>/pools/status
Get the statistics of load balancer service Returns the statistics of the given load balancer service.	GET /api/v1/loadbalancer/services/<service-id>/statistics
Get the status of the given load balancer service Returns the status of the given load balancer service.	GET /api/v1/loadbalancer/services/<service-id>/status
Read the usage information of the given load balancer service API to fetch the capacity and current usage of the given load balancer service.	GET /api/v1/loadbalancer/services/<service-id>/usage
Get the statistics of the given load balancer virtual server Returns the statistics of the load balancer virtual server by given load balancer serives id and load balancer virtual server id.	GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/<virtual-server-id>/statistics
Get the status of the load balancer virtual server Returns the status of the virtual server by given load balancer serives id and load balancer virtual server id.	GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/<virtual-server-id>/status
Get the statistics list of virtual servers Returns the statistics list of virtual servers in given load balancer service. Currently, only realtime mode is supported.	GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/statistics
Get the status list of virtual servers in given load balancer service Returns the status list of virtual servers in given load balancer service.	GET /api/v1/loadbalancer/services/<service-id>/virtual-servers/status
Retrieve a list of supported SSL ciphers and protocols Retrieve a list of supported SSL ciphers and protocols.	GET /api/v1/loadbalancer/ssl/ciphers-and-protocols
Read load balancer usage for the given node API is used to retrieve the usage of load balancer entities which include current number and remaining number of credits, virtual Servers, pools, pool Members and different size of LB services from the given node. Currently only Edge node is supported.	GET /api/v1/loadbalancer/usage-per-node/<node-id>
Retrieve a paginated list of load balancer virtual servers Retrieve a paginated list of load balancer virtual servers.	GET /api/v1/loadbalancer/virtual-servers
Create a load balancer virtual server Create a load balancer virtual server.	POST /api/v1/loadbalancer/virtual-servers
Create a load balancer virtual server with rules It is used to create virtual servers, the associated rules and bind the rules to the virtual server. To add new rules, make sure the rules which have no identifier specified, the new rules are automatically generated and associated to the virtual server. If the virtual server need to consume some existed rules without change, those rules should not be specified in this array, otherwise, the rules are updated.	POST /api/v1/loadbalancer/virtual-servers?action=create_with_rules
Delete a load balancer virtual server Delete a load balancer virtual server.	DELETE /api/v1/loadbalancer/virtual-servers/<virtual-server-id>
Retrieve a load balancer virtual server Retrieve a load balancer virtual server.	GET /api/v1/loadbalancer/virtual-servers/<virtual-server-id>
Update a load balancer virtual server with rules It is used to update virtual servers, the associated rules and update the binding of virtual server and rules. To add new rules, make sure the rules which have no identifier specified, the new rules are automatically generated and associated to the virtual server. To delete old rules, the rules should not be configured in new action, the UUID of deleted rules should be also removed from rule_ids. To update rules, the rules should be specified with new change and configured with identifier. If there are some rules which are not modified, those rule should not be specified in the rules list, the UUID list of rules should be specified in rule_ids of LbVirtualServer.	PUT /api/v1/loadbalancer/virtual-servers/<virtual-server-id>?action=update_with_rules
Update a load balancer virtual server Update a load balancer virtual server.	PUT /api/v1/loadbalancer/virtual-servers/<virtual-server-id>
List All Logical Ports Returns information about all configured logical switch ports. Logical switch ports connect to VM virtual network interface cards (NICs). Each logical port is associated with one logical switch.	GET /api/v1/logical-ports
Create a Logical Port Creates a new logical switch port. The required parameters are the associated logical_switch_id and admin_state (UP or DOWN). Optional parameters are the attachment and switching_profile_ids. If you don't specify switching_profile_ids, default switching profiles are assigned to the port. If you don't specify an attachment, the switch port remains empty. To configure an attachment, you must specify an id, and optionally you can specify an attachment_type (VIF or LOGICALROUTER). The attachment_type is VIF by default.	POST /api/v1/logical-ports
Delete a Logical Port Deletes the specified logical switch port. By default, if logical port has attachments, or it is added to any NSGroup, the deletion will be failed. Option detach could be used for deleting logical port forcibly.	DELETE /api/v1/logical-ports/<lport-id>
Get Information About a Logical Port Returns information about a specified logical port.	GET /api/v1/logical-ports/<lport-id>
Update a Logical Port Modifies an existing logical switch port. Parameters that can be modified include attachment_type (LOGICALROUTER, VIF), admin_state (UP or DOWN), attachment id and switching_profile_ids. You cannot modify the logical_switch_id. In other words, you cannot move an existing port from one switch to another switch.	PUT /api/v1/logical-ports/<lport-id>
Get MAC table of a logical port with a given port id (lport-id) Returns MAC table of a specified logical port. If the target transport node id is not provided, the NSX manager will ask the controller for the transport node where the logical port is located. The query parameter "source=cached" is not supported. MAC table retrieval is not supported on logical ports that are attached to a logical router.	GET /api/v1/logical-ports/<lport-id>/mac-table
Get MAC table of a logical port with a given port id (lport-id) Returns MAC table in CSV format of a specified logical port. If the target transport node id is not provided, the NSX manager will ask the controller for the transport node where the logical port is located. The query parameter "source=cached" is not supported. MAC table retrieval is not supported on logical ports that are attached to a logical router.	GET /api/v1/logical-ports/<lport-id>/mac-table?format=csv
Get realized state & location of a logical port Returns transport node id for a specified logical port. Also returns information about all address bindings of the specified logical port. This includes address bindings discovered via various snooping methods like ARP snooping, DHCP snooping etc. and addressing bindings that are realized based on user configuration.	GET /api/v1/logical-ports/<lport-id>/state
Get Statistics for Logical Port of a Given Port ID (lport-id) Returns statistics of a specified logical port. If the logical port is attached to a logical router port, query parameter "source=realtime" is not supported.	GET /api/v1/logical-ports/<lport-id>/statistics
Get Operational Status for Logical Port of a Given Port ID (lport-id) Returns operational status of a specified logical port.	GET /api/v1/logical-ports/<lport-id>/status
Get Operational Status Summary of All Logical Ports in the System Returns operational status of all logical ports. The query parameter "source=realtime" is not supported. Pagination is not supported for this API. The query parameters "cursor", "sort_ascending", "sort_by", "page_size" and "included_fields" will be ignored.	GET /api/v1/logical-ports/status
List Logical Router Ports Returns information about all logical router ports. Information includes the resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); logical_router_id (the router to which each logical router port is assigned); and any service_bindings (such as DHCP relay service). The GET request can include a query parameter (logical_router_id or logical_switch_id).	GET /api/v1/logical-router-ports
Create a Logical Router Port Creates a logical router port. The required parameters include resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); and logical_router_id (the router to which each logical router port is assigned). The service_bindings parameter is optional.	POST /api/v1/logical-router-ports
Delete a Logical Router Port Deletes the specified logical router port. You must delete logical router ports before you can delete the associated logical router. To Delete Tier0 router link port you must have to delete attached tier1 router link port, otherwise pass "force=true" as query param to force delete the Tier0 router link port.	DELETE /api/v1/logical-router-ports/<logical-router-port-id>
Read Logical Router Port Returns information about the specified logical router port.	GET /api/v1/logical-router-ports/<logical-router-port-id>
Update a Logical Router Port Modifies the specified logical router port. Required parameters include the resource_type and logical_router_id. Modifiable parameters include the resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort), logical_router_id (to reassign the port to a different router), and service_bindings.	PUT /api/v1/logical-router-ports/<logical-router-port-id>
Get the ARP table (IPv4) or Neighbor Discovery table (IPv6) for the Logical Router Port of the given id Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the Logical Router Port of the given id, on a node if a query parameter "transport_node_id=" is given. The transport_node_id parameter is mandatory if the router port is not uplink type. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-router-ports/<logical-router-port-id>/arp-table
Get the ARP table (IPv4) or Neighbor Discovery table (IPv6) for the Logical Router Port of the given id Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the Logical Router Port of the given id, on a node if a query parameter "transport_node_id=" is given. The transport_node_id parameter is mandatory if the router port is not uplink type. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-router-ports/<logical-router-port-id>/arp-table?format=csv
Get the Realized State of a Logical Router Port Return realized state information of a logical router port. Any configuration update that affects the logical router port can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of logical router ports, dhcp relays, etc.	GET /api/v1/logical-router-ports/<logical-router-port-id>/state
Get the statistics of a specified logical router port on all or a specified node Returns the statistics for the Logical Router Port. If query parameter "transport_node_id=" is given, only the statistics from the given node for the logical router port will be returned. Otherwise the statistics from each node for the same logical router port will be returned. The transport_node_id is mandatory if the router port is not uplink type. The query parameter "source=cached" will be ignored and it will always return realtime statistics of the logical router port.	GET /api/v1/logical-router-ports/<logical-router-port-id>/statistics
Get the statistics summary of a specified logical router port Returns the summation of statistics from all nodes for the Specified Logical Router Port. The query parameter "source=realtime" is not supported.	GET /api/v1/logical-router-ports/<logical-router-port-id>/statistics/summary
List Logical Routers Returns information about all logical routers, including the UUID, internal and external transit network addresses, and the router type (TIER0 or TIER1). You can get information for only TIER0 routers or only the TIER1 routers by including the router_type query parameter.	GET /api/v1/logical-routers
Create a Logical Router Creates a logical router. The required parameters are router_type (TIER0 or TIER1) and edge_cluster_id (TIER0 only). Optional parameters include internal and external transit network addresses.	POST /api/v1/logical-routers
Delete a Logical Router Deletes the specified logical router. You must delete associated logical router ports before you can delete a logical router. Otherwise use force delete which will delete all related ports and other entities associated with that LR. To force delete logical router pass force=true in query param.	DELETE /api/v1/logical-routers/<logical-router-id>
Read Logical Router Returns information about the specified logical router.	GET /api/v1/logical-routers/<logical-router-id>
Re allocate edge node placement of TIER1 service routers API to re allocate edge node placement for TIER1 logical router. You can re-allocate service routers of TIER1 in same edge cluster or different edge cluster. You can also place edge nodes manually and provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocate on new edge cluster you must have existing edge cluster for TIER1 logical router. This will be disruptive operation and all existing statistics of logical router will be remove.	POST /api/v1/logical-routers/<logical-router-id>?action=reallocate
Reprocesses a logical router configuration and publish updates to controller Reprocess logical router configuration and configuration of related entities like logical router ports, static routing, etc. Any missing Updates are published to controller.	POST /api/v1/logical-routers/<logical-router-id>?action=reprocess
Update a Logical Router Modifies the specified logical router. Modifiable attributes include the internal_transit_network, external_transit_networks, and edge_cluster_id (for TIER0 routers).	PUT /api/v1/logical-routers/<logical-router-id>
Read the debug information for the logical router API to download below information as text which will be used for debugging and troubleshooting. 1) Logical router sub-components and ports. 2) Routing configuration as sent to central control plane. 3) TIER1 advertised network information.	GET /api/v1/logical-routers/<logical-router-id>/debug-info?format=text
List NAT rules of the logical router Returns paginated list of all user defined NAT rules of the specific logical router. If a rule_type is provided, only the given type of rules will be returned. If no rule_type is specified, the rule_type will be defaulted to NATv4, i.e. only the NATv4 rules will be listed.	GET /api/v1/logical-routers/<logical-router-id>/nat/rules
Add multiple NAT rules in a specific logical router Create multiple NAT rules in a specific logical router. The API succeeds only when all rules are accepted and created successfully. Any one validation voilation will fail the API, no rule will be created. The ruleIds of each rules can be found from the responsed message.	POST /api/v1/logical-routers/<logical-router-id>/nat/rules?action=create_multiple
Add a NAT rule in a specific logical router Add a NAT rule in a specific logical router.	POST /api/v1/logical-routers/<logical-router-id>/nat/rules
Delete a specific NAT rule from a logical router Delete a specific NAT rule from a logical router	DELETE /api/v1/logical-routers/<logical-router-id>/nat/rules/<rule-id>
Get a specific NAT rule from a given logical router Get a specific NAT rule from a given logical router	GET /api/v1/logical-routers/<logical-router-id>/nat/rules/<rule-id>
Update a specific NAT rule from a given logical router Update a specific NAT rule from a given logical router.	PUT /api/v1/logical-routers/<logical-router-id>/nat/rules/<rule-id>
Get the statistics of a specified logical router NAT Rule Returns the summation of statistics from all nodes for the Specified Logical Router NAT Rule. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-routers/<logical-router-id>/nat/rules/<rule-id>/statistics
Get the statistics of all rules of the logical router Returns the summation of statistics for all rules from all nodes for the Specified Logical Router. Also gives the per transport node statistics for provided logical router. The query parameter "source=realtime" is not supported.	GET /api/v1/logical-routers/<logical-router-id>/nat/rules/statistics
Read the Routing Configuration Returns the routing configuration for a specified logical router.	GET /api/v1/logical-routers/<logical-router-id>/routing
Update the Routing Configuration Modifies the routing configuration for a specified logical router.	PUT /api/v1/logical-routers/<logical-router-id>/routing
Read the Advertisement Configuration on a Logical Router Returns information about the routes to be advertised by the specified TIER1 logical router.	GET /api/v1/logical-routers/<logical-router-id>/routing/advertisement
Update the Advertisement Configuration on a Logical Router Modifies the route advertisement configuration on the specified logical router.	PUT /api/v1/logical-routers/<logical-router-id>/routing/advertisement
Read the Advertisement Rules on a Logical Router Returns the advertisement rule list for the specified TIER1 logical router.	GET /api/v1/logical-routers/<logical-router-id>/routing/advertisement/rules
Update the Advertisement Rules on a Logical Router Modifies the advertisement rules on the specified logical router. The PUT request must include all the rules with the networks parameter. Modifiable parameters are networks, display_name, and description. Set the rules list to empty to delete/clear all rules.	PUT /api/v1/logical-routers/<logical-router-id>/routing/advertisement/rules
Read the Routing BFD Configuration Returns the BFD configuration for all routing BFD peers. This will be inherited \| by all BFD peers for LogicalRouter unless overriden while configuring the Peer.	GET /api/v1/logical-routers/<logical-router-id>/routing/bfd-config
Update the BFD Configuration for BFD peers for routing Modifies the BFD configuration for routing BFD peers. Note - the configuration \| changes apply only to those routing BFD peers for which the BFD configuration has \| not been overridden at Peer level.	PUT /api/v1/logical-routers/<logical-router-id>/routing/bfd-config
Read the BGP Configuration on a Logical Router Returns information about the BGP configuration on a specified logical router. Information includes whether or not the BGP configuration is enabled, the AS number, and whether or not graceful restart is enabled.	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp
Update the BGP Configuration on a Logical Router Modifies the BGP configuration on a specified TIER0 logical router. Modifiable parameters include enabled, graceful_restart, as_number.	PUT /api/v1/logical-routers/<logical-router-id>/routing/bgp
Paginated list of BGP community lists on a logical router Paginated list of BGP Community Lists on a Logical Router	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists
Create a new BGP community list on a logical router Add a new BGP Community List on a Logical Router	POST /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists
Delete a specific BGP community list from a logical router Delete a specific BGP community list from a Logical Router	DELETE /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists/<community-list-id>
Read a specific BGP community list from a logical router Read a specific BGP community list from a Logical Router	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists/<community-list-id>
Update a specific BGP community list from a logical router Update a specific BGP community list from a Logical Router	PUT /api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists/<community-list-id>
Update a specific BGP community list from a logical router Update a specific BGP community list from a Logical Router	PUT /api/v1/logical-routers/<logical-router-id>/routing/bgp/communty-lists/<community-list-id> (Deprecated)
Paginated list of BGP Neighbors on a Logical Router Paginated list of BGP Neighbors on a Logical Router	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors
Add a new BGP Neighbor on a Logical Router Add a new BGP Neighbor on a Logical Router	POST /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors
Delete a specific BGP Neighbor on a Logical Router Delete a specific BGP Neighbor on a Logical Router	DELETE /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id>
Read a specific BGP Neighbor with password on a Logical Router Read a specific BGP Neighbor details with password on a Logical Router	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id>?action=show-sensitive-data
Read a specific BGP Neighbor on a Logical Router Read a specific BGP Neighbor on a Logical Router	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id>
Unset/Delete password property on specific BGP Neighbor on Logical Router Unset/Delete the password property on the specific BGP Neighbor. No other property of the BgpNeighbor can be updated using this API	POST /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id>
Update a specific BGP Neighbor on a Logical Router Update a specific BGP Neighbor on a Logical Router	PUT /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id>
Get BGP neighbor advertised routes Returns routes advertised by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled. It always returns realtime response.	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/advertised-routes
Get BGP neighbor advertised routes in CSV format Returns routes advertised by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled in CSV format. It always returns realtime response.	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/advertised-routes?format=csv
Get BGP neighbor learned routes in CSV format Returns routes learned by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled in CSV format. It always returns realtime response.	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/routes?format=csv
Get BGP neighbor learned routes Returns routes learned by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled. It always returns realtime response.	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/routes
Get the status of all the BGP neighbors for the Logical Router of the given id Returns the status of all the BGP neighbors for the Logical Router of the given id. To get BGP neighbors status for the logical router from particular node, parameter "transport_node_id=" needs to be specified. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/status
Get FIB table on a specified node for a logical router Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter "transport_node_id=" is required. To filter the result by network address, paramter "network_prefix=" needs to be specified. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-routers/<logical-router-id>/routing/forwarding-table
Get FIB table on a specified node for a logical router Returns the FIB table in CSV format for the logical router on a node of the given transport-node-id. Query parameter "transport_node_id=" is required. To filter the result by network address, paramter "network_prefix=" needs to be specified. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-routers/<logical-router-id>/routing/forwarding-table?format=csv
Paginated List of IPPrefixLists Paginated List of IPPrefixLists	GET /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists
Add IPPrefixList on a Logical Router Adds a new IPPrefixList on a Logical Router	POST /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists
Delete a specific IPPrefixList on a Logical Router Deletes a specific IPPrefixList on the specified logical router.	DELETE /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists/<id>
Get a specific IPPrefixList on a Logical Router Read a specific IPPrefixList on the specified logical router.	GET /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists/<id>
Update a specific IPPrefixList on a Logical Router Update a specific IPPrefixList on the specified logical router.	PUT /api/v1/logical-routers/<logical-router-id>/routing/ip-prefix-lists/<id>
Read the Redistribution Configuration on a Logical Router Returns information about configured route redistribution for the specified logical router.	GET /api/v1/logical-routers/<logical-router-id>/routing/redistribution
Update the Redistribution Configuration on a Logical Router Modifies existing route redistribution rules for the specified TIER0 logical router.	PUT /api/v1/logical-routers/<logical-router-id>/routing/redistribution
Read All the Redistribution Rules on a Logical Router Returns all the route redistribution rules for the specified logical router.	GET /api/v1/logical-routers/<logical-router-id>/routing/redistribution/rules
Update All the Redistribution Rules on a Logical Router Modifies all route redistribution rules for the specified TIER0 logical router. Set the rules list to empty to delete/clear all rules.	PUT /api/v1/logical-routers/<logical-router-id>/routing/redistribution/rules
Paginated List of RouteMaps Paginated List of RouteMaps	GET /api/v1/logical-routers/<logical-router-id>/routing/route-maps
Add RouteMap on a Logical Router Adds a new RouteMap on a Logical Router	POST /api/v1/logical-routers/<logical-router-id>/routing/route-maps
Delete a specific RouteMap on a Logical Router Deletes a specific RouteMap on the specified logical router.	DELETE /api/v1/logical-routers/<logical-router-id>/routing/route-maps/<id>
Get a specific RouteMap on a Logical Router Read a specific RouteMap on the specified logical router.	GET /api/v1/logical-routers/<logical-router-id>/routing/route-maps/<id>
Update a specific RouteMap on a Logical Router Update a specific RouteMap on the specified logical router.	PUT /api/v1/logical-routers/<logical-router-id>/routing/route-maps/<id>
Get route table on a node for a logical router Deprecated - Please use /logical-routers//routing/routing-table for RIB and /logical-routers//routing/forwarding-table for FIB. Returns the route table in CSV format for the logical router on a node of the given transport-node-id. Query parameter "transport_node_id=" is required. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-routers/<logical-router-id>/routing/route-table?format=csv (Deprecated)
Get route table on a given node for a logical router Deprecated - Please use /logical-routers//routing/routing-table for RIB and /logical-routers//routing/forwarding-table for FIB. Returns the route table for the logical router on a node of the given transport-node-id. Query parameter "transport_node_id=" is required. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-routers/<logical-router-id>/routing/route-table (Deprecated)
Get RIB table on a specified node for a logical router Returns the route table(RIB) for the logical router on a node of the given transport-node-id. Query parameter "transport_node_id=" is required. To filter the result by network address, parameter "network_prefix=" needs to be specified. To filter the result by route source, parameter "route_source=" needs to be specified where source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT. It is also possible to filter the RIB table using both network address and route source filter together. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-routers/<logical-router-id>/routing/routing-table
Get RIB table on a specified node for a logical router Returns the route table in CSV format for the logical router on a node of the given transport-node-id. Query parameter "transport_node_id=" is required. To filter the result by network address, paramter "network_prefix=" needs to be specified. To filter the result by route source, parameter "route_source=" needs to be specified where source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT. It is also possible to filter the RIB table using both network address and route source filter together. Query parameter "source=realtime" is the only supported source.	GET /api/v1/logical-routers/<logical-router-id>/routing/routing-table?format=csv
Paginated List of Static Routes Returns information about configured static routes, including the network address and next hops for each static route.	GET /api/v1/logical-routers/<logical-router-id>/routing/static-routes
Add Static Routes on a Logical Router Adds a new static route on a Logical Router	POST /api/v1/logical-routers/<logical-router-id>/routing/static-routes
Delete a specific Static Route on a Logical Router Deletes a specific static route on the specified logical router.	DELETE /api/v1/logical-routers/<logical-router-id>/routing/static-routes/<id>
Get a specific Static Route on a Logical Router Read a specific static routes on the specified logical router.	GET /api/v1/logical-routers/<logical-router-id>/routing/static-routes/<id>
Update a specific Static Route Rule on a Logical Router Update a specific static route on the specified logical router.	PUT /api/v1/logical-routers/<logical-router-id>/routing/static-routes/<id>
List static routes BFD Peers Returns information about all BFD peers created on specified logical router for static routes.	GET /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers
Create a static hop BFD peer Creates a BFD peer for static route. The required parameters includes peer IP address.	POST /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers
Delete a specified static route BFD peer cofigured on a specified logical router Deletes the specified BFD peer present on specified logical router.	DELETE /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers/<bfd-peer-id>
Read a static route BFD peer Read the BFD peer having specified ID.	GET /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers/<bfd-peer-id>
Update a static route BFD peer Modifies the static route BFD peer. Modifiable parameters includes peer IP, enable flag and configuration of the BFD peer.	PUT /api/v1/logical-routers/<logical-router-id>/routing/static-routes/bfd-peers/<bfd-peer-id>
Get the Realized State of a Logical Service Router Cluster Return realized state information of a logical service router cluster. Any configuration update that affects the logical service router cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of nat, bgp, bfd, etc. What is a Service Router? When a service cannot be distributed is enabled on a Logical Router, a Service Router (SR) is instantiated. Some examples of services that are not distributed are NAT, DHCP server, Metadata Proxy, Edge Firewall, Load Balancer and so on.	GET /api/v1/logical-routers/<logical-router-id>/service-cluster/state
Get the Realized State of a Logical Router Return realized state information of a logical router. Any configuration update that affects the logical router can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of logical router, static routes, etc.	GET /api/v1/logical-routers/<logical-router-id>/state
Get the status for the Logical Router of the given id Returns status for the Logical Router of the given id.	GET /api/v1/logical-routers/<logical-router-id>/status
List all Logical Switches Returns information about all configured logical switches.	GET /api/v1/logical-switches
Create a Logical Switch Creates a new logical switch. The request must include the transport_zone_id, display_name, and admin_state (UP or DOWN). The replication_mode (MTEP or SOURCE) is required for overlay logical switches, but not for VLAN-based logical switches. A vlan needs to be provided for VLAN-based logical switches	POST /api/v1/logical-switches
Get L2 forwarder remote mac addresses Returns remote mac addresses of the l2 forwarder on logical switch. It always returns realtime response.	GET /api/v1/logical-switches/<logical-switch-id>/inter-site-forwarder/site-span-info (Experimental)
Get L2 forwarder statistics Returns statistics of the l2 forwarder on logical switch. It always returns realtime response.	GET /api/v1/logical-switches/<logical-switch-id>/inter-site-forwarder/statistics (Experimental)
Get L2 forwarder status Returns status per transport node of the l2 forwarder on logical switch.	GET /api/v1/logical-switches/<logical-switch-id>/inter-site-forwarder/status (Experimental)
Delete a Logical Switch Removes a logical switch from the associated overlay or VLAN transport zone. By default, a logical switch cannot be deleted if there are logical ports on the switch, or it is added to a NSGroup. Cascade option can be used to delete all ports and the logical switch. Detach option can be used to delete the logical switch forcibly.	DELETE /api/v1/logical-switches/<lswitch-id>
Get Logical Switch associated with the provided id (lswitch-id) Returns information about the specified logical switch Id.	GET /api/v1/logical-switches/<lswitch-id>
Update a Logical Switch Modifies attributes of an existing logical switch. Modifiable attributes include admin_state, replication_mode, switching_profile_ids and VLAN spec. You cannot modify the original transport_zone_id.	PUT /api/v1/logical-switches/<lswitch-id>
Get MAC Table for Logical Switch of the Given ID (lswitch-id) Returns MAC table of a specified logical switch from the given transport node if a transport node id is given in the query parameter from the Central Controller Plane. The query parameter "source=cached" is not supported.	GET /api/v1/logical-switches/<lswitch-id>/mac-table
Get MAC Table for Logical Switch of the Given ID (lswitch-id) Returns MAC table of a specified logical switch in CSV format from the given transport node if a transport node id is given in the query parameter from the Central Controller Plane. The query parameter "source=cached" is not supported.	GET /api/v1/logical-switches/<lswitch-id>/mac-table?format=csv
Get the realized state associated with provided logical switch id Returns current state of the logical switch configuration and details of only out-of-sync transport nodes.	GET /api/v1/logical-switches/<lswitch-id>/state
Get Statistics for Logical Switch of the Given ID (lswitch-id) Returns statistics of a specified logical switch. The query parameter "source=realtime" is not supported.	GET /api/v1/logical-switches/<lswitch-id>/statistics
Get Logical Switch runtime status info for a given logical switch Returns the number of ports assigned to a logical switch.	GET /api/v1/logical-switches/<lswitch-id>/summary
Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id) Returns the virtual tunnel endpoint table of a specified logical switch from the given transport node if a transport node id is given in the query parameter, from the Central Controller Plane. The query parameter "source=cached" is not supported.	GET /api/v1/logical-switches/<lswitch-id>/vtep-table
Get virtual tunnel endpoint table for logical switch of the given ID (lswitch-id) Returns virtual tunnel endpoint table of a specified logical switch in CSV format from the given transport node if a transport node id is given in the query parameter from the Central Controller Plane. The query parameter "source=cached" is not supported.	GET /api/v1/logical-switches/<lswitch-id>/vtep-table?format=csv
List logical switches by realized state Returns a list of logical switches states that have realized state as provided as query parameter.	GET /api/v1/logical-switches/state
Get Status Summary of All Logical Switches in the System Returns Operational status of all logical switches. The query parameter "source=realtime" is not supported.	GET /api/v1/logical-switches/status
Get a paginated list of metadata proxies	GET /api/v1/md-proxies
Create a metadata proxy	POST /api/v1/md-proxies
Delete a metadata proxy	DELETE /api/v1/md-proxies/<proxy-id>
Get a metadata proxy	GET /api/v1/md-proxies/<proxy-id>
Update a metadata proxy	PUT /api/v1/md-proxies/<proxy-id>
Get Metadata Proxy status with given proxy id and attached logical switch. Returns the status of the given metadata proxy and attached logical switch.	GET /api/v1/md-proxies/<proxy-id>/<logical-switch-id>/status
List All PBR Sections List all PBR section in paginated form. A default page size is limited to 1000 PBR sections.	GET /api/v1/pbr/sections
Create a Section with Rules Creates a new PBR section with rules. The limit on the number of rules is defined by maxItems in collection types for PBRRule (PBRRuleXXXList types). When invoked on a section with a large number of rules, this API is supported only at low rates of invocation (not more than 4-5 times per minute). The typical latency of this API with about 1024 rules is about 4-5 seconds. This API should not be invoked with large payloads at automation speeds. More than 50 rules with a large number of rule references is not supported. Instead, to create sections, use: POST /api/v1/pbr/sections To create rules, use: POST /api/v1/pbr/sections/<section-id>/rules	POST /api/v1/pbr/sections?action=create_with_rules
Create a New Empty Section Creates new empty PBR section in the system.	POST /api/v1/pbr/sections
Delete an Existing Section and Its Associated Rules Removes PBR section from the system. PBR section with rules can only be deleted by passing "cascade=true" parameter.	DELETE /api/v1/pbr/sections/<section-id>
Get an Existing Section Returns information about PBR section for the identifier.	GET /api/v1/pbr/sections/<section-id>
Update an Existing Section, Including Its Rules Modifies existing PBR section along with its association with rules. When invoked on a large number of rules, this API is supported only at low rates of invocation (not more than 2 times per minute). The typical latency of this API with about 1024 rules is about 15 seconds in a cluster setup. This API should not be invoked with large payloads at automation speeds. Instead, to update rule content, use: PUT /api/v1/pbr/sections/<section-id>/rules/<rule-id>	POST /api/v1/pbr/sections/<section-id>?action=update_with_rules
Update an Existing Section, including Its Position Modifies an existing PBR section along with its relative position among other PBR sections in the system.	POST /api/v1/pbr/sections/<section-id>?action=revise
Update an Existing Section with Rules Modifies an existing PBR section along with its relative position among other PBR sections with rules. When invoked on a large number of rules, this API is supported only at low rates of invocation (not more than 2 times per minute). The typical latency of this API with about 1024 rules is about 15 seconds in a cluster setup. This API should not be invoked with large payloads at automation speeds. Instead, to move a section above or below another section, use: POST /api/v1/pbr/sections/<section-id>?action=revise To modify rules, use: PUT /api/v1/pbr/sections/<section-id>/rules/<rule-id>	POST /api/v1/pbr/sections/<section-id>?action=revise_with_rules
Get an Existing Section, Including Rules Returns PBR section information with rules for a section identifier. When invoked on a section with a large number of rules, this API is supported only at low rates of invocation (not more than 4-5 times per minute). The typical latency of this API with about 1024 rules is about 4-5 seconds. This API should not be invoked with large payloads at automation speeds. More than 50 rules with a large number rule references is not supported. Instead, to read PBR rules, use: GET /api/v1/pbr/sections/<section-id>/rules with the appropriate page_size.	POST /api/v1/pbr/sections/<section-id>?action=list_with_rules
Update an Existing Section Modifies the specified section, but does not modify the section's associated rules.	PUT /api/v1/pbr/sections/<section-id>
Get All the Rules for a Section Return all PBR rule(s) information for a given PBR section.	GET /api/v1/pbr/sections/<section-id>/rules
Add a Single Rule in a Section Adds a new PBR rule in existing PBR section.	POST /api/v1/pbr/sections/<section-id>/rules
Add Multiple Rules in a Section Create multiple PBR rules in existing PBR section bounded by limit of 1000 PBR rules per section.	POST /api/v1/pbr/sections/<section-id>/rules?action=create_multiple
Delete an Existing Rule Delete existing PBR rule in a PBR section.	DELETE /api/v1/pbr/sections/<section-id>/rules/<rule-id>
Read an Existing Rule Return existing PBR rule information in a PBR section.	GET /api/v1/pbr/sections/<section-id>/rules/<rule-id>
Update an Existing Rule and Reorder the Rule Modifies existing PBR rule along with relative position among other PBR rules inside a PBR section.	POST /api/v1/pbr/sections/<section-id>/rules/<rule-id>?action=revise
Update an Existing Rule Modifies existing rule in a PBR section.	PUT /api/v1/pbr/sections/<section-id>/rules/<rule-id>
Get PBR rule level statistics. Get aggregated statistics for a rule for given PBR rule. Stats include total number of packets and total number of bytes for the PBR rule.	GET /api/v1/pbr/sections/<section-id>/rules/<rule-id>/stats
Get PBR section level statistics. Get aggregated statistics for all rules for a given pbr section. Data includes total number of packets, and total number of bytes for all PBR rules in the given section.	GET /api/v1/pbr/sections/<section-id>/rules/stats
List Switching Profiles Returns information about the system-default and user-configured switching profiles. Each switching profile has a unique ID, a display name, and various other read-only and configurable properties. The default switching profiles are assigned automatically to each switch.	GET /api/v1/switching-profiles
Create a Switching Profile Creates a new, custom qos, port-mirroring, spoof-guard or port-security switching profile. You can override their default switching profile assignments by creating a new switching profile and assigning it to one or more logical switches. You cannot override the default ipfix or ip_discovery switching profiles.	POST /api/v1/switching-profiles
Delete a Switching Profile Deletes the specified switching profile.	DELETE /api/v1/switching-profiles/<switching-profile-id>
Get Switching Profile by ID Returns information about a specified switching profile.	GET /api/v1/switching-profiles/<switching-profile-id>
Update a Switching Profile Updates the user-configurable parameters of a switching profile. Only the qos, port-mirroring, spoof-guard and port-security switching profiles can be modified. You cannot modify the ipfix or ip-discovery switching profiles.	PUT /api/v1/switching-profiles/<switching-profile-id>
Get Counts of Ports and Switches Using This Switching Profile	GET /api/v1/switching-profiles/<switching-profile-id>/summary
Get statistics for all logical router NAT rules on a transport node Returns the summation of statistics for all rules from all logical routers which are present on given transport node. Only cached statistics are supported. The query parameter "source=realtime" is not supported.	GET /api/v1/transport-nodes/<node-id>/statistics/nat-rules
Get IPSec dead peer detection (DPD) profile list result Get paginated list of all dead peer detection (DPD) profiles.	GET /api/v1/vpn/ipsec/dpd-profiles
Create dead peer detection (DPD) profile Create dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile.	POST /api/v1/vpn/ipsec/dpd-profiles
Delete dead peer detection (DPD) profile Delete dead peer detection (DPD) profile.	DELETE /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id>
Get IPSec dead peer detection (DPD) profile Get IPSec dead peer detection (DPD) profile.	GET /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id>
Edit IPSec dead peer detection (DPD) profile Edit IPSec dead peer detection (DPD) profile.	PUT /api/v1/vpn/ipsec/dpd-profiles/<ipsec-vpn-dpd-profile-id>
List IKE profiles Get paginated list of all IKE Profiles.	GET /api/v1/vpn/ipsec/ike-profiles
Create custom internet key exchange (IKE) Profile Create custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned non editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile.	POST /api/v1/vpn/ipsec/ike-profiles
Delete custom IKE Profile Delete custom IKE Profile. Profile can not be deleted if profile has references to it.	DELETE /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id>
Get IKE Profile Get custom IKE Profile, given the particular id.	GET /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id>
Edit custom IKE Profile Edit custom IKE Profile. System owned profiles are non editable.	PUT /api/v1/vpn/ipsec/ike-profiles/<ipsec-vpn-ike-profile-id>
Get IPSec local endpoint list result Get paginated list of all local endpoints.	GET /api/v1/vpn/ipsec/local-endpoints
Create custom local endpoint Create custom IPSec local endpoint.	POST /api/v1/vpn/ipsec/local-endpoints
Delete custom IPSec local endpoint Delete custom IPSec local endpoint.	DELETE /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id>
Get custom IPSec local endpoint Get custom IPSec local endpoint.	GET /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id>
Edit custom IPSec local endpoint Edit custom IPSec local endpoint.	PUT /api/v1/vpn/ipsec/local-endpoints/<ipsec-vpn-local-endpoint-id>
Get IPSecVPNPeerEndpoint List Result Get paginated list of all peer endpoint.	GET /api/v1/vpn/ipsec/peer-endpoints
Create custom peer endpoint Create custom IPSec peer endpoint.	POST /api/v1/vpn/ipsec/peer-endpoints
Delete custom IPSec VPN peer endpoint Delete custom IPSec VPN peer endpoint. All references are strong references and dependent peer endpoints can not be deleted if being referenced.	DELETE /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>
Get IPSec VPN peer endpoint Get custom IPSec VPN peer endpoint.	GET /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>
Get IPSec VPN peer endpoint with PSK Get custom IPSec VPN peer endpoint with PSK.	GET /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>?action=show-sensitive-data
Edit custom IPSecPeerEndpoint Edit custom IPSec peer endpoint. System owned endpoints are non editable.	PUT /api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>
Get IPSec VPN service list result Get paginated list of all IPSec VPN services.	GET /api/v1/vpn/ipsec/services
Create VPN service Create VPN service for given logical router.	POST /api/v1/vpn/ipsec/services
Delete IPSec VPN service Delete IPSec VPN service for given router.	DELETE /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id>
Get IPSec VPN service Get IPSec VPN service for given logical router.	GET /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id>
Edit IPSec VPN service Edit IPSec VPN service for given logical router.	PUT /api/v1/vpn/ipsec/services/<ipsec-vpn-service-id>
Get IPSec VPN session list result Get paginated list of all IPSec VPN sessions.	GET /api/v1/vpn/ipsec/sessions
Create new VPN session Create new VPN session.	POST /api/v1/vpn/ipsec/sessions
Delete IPSec VPN session Delete IPSec VPN session.	DELETE /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>
Fetch IPSec VPN session Fetch IPSec VPN session.	GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>
Edit IPSec VPN session Edit IPSec VPN session.	PUT /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>
Get VPN configuration for the peer site API to download VPN configuration for the peer site. The configuration contains pre-shared key and secret; be careful when sharing or storing it.	GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/peer-config
Get the Realized State of a IPSec VPN Session Return realized state information of a ipsec vpn session. Any configuration update that affects the ipsec vpn session can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of ipsec vpn session, service, endpoints, profiles, etc. It will return a service disabled error, if the ipsec vpn service associated with the session is disabled.	GET /api/v1/vpn/ipsec/sessions/<ipsec-vpn-session-id>/state
Get IPSec VPN session statistics Get statistics of a vpn session across all tunnels and IKE session. Query parameter "source=realtime" is the only supported source.	GET /api/v1/vpn/ipsec/sessions/<session-id>/statistics
Reset the statistics of the given VPN session Reset the statistics of the given VPN session.	POST /api/v1/vpn/ipsec/sessions/<session-id>/statistics?action=reset
Get IPSec VPN IKE session status List status of IPSec session. Query parameter source supports both realtime and cached mode.	GET /api/v1/vpn/ipsec/sessions/<session-id>/status
VPN session summary VPN session summary gets summary per vpn sessions and IKE session. Query parameter source supports only cached mode.	GET /api/v1/vpn/ipsec/sessions/summary
Get IPSecTunnelProfile List Result Get paginated list of all IPSecTunnelProfiles.	GET /api/v1/vpn/ipsec/tunnel-profiles
Create custom IPSec tunnel profile Create custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned non editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile.	POST /api/v1/vpn/ipsec/tunnel-profiles
Delete custom IPSecTunnelProfile Delete custom IPSec Tunnel Profile.	DELETE /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id>
Get IPSec tunnel profile Get custom IPSec Tunnel Profile.	GET /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id>
Edit custom IPSecTunnelProfile Edit custom IPSec Tunnel Profile. System owned profiles are non editable.	PUT /api/v1/vpn/ipsec/tunnel-profiles/<ipsec-vpn-tunnel-profile-id>
Get all L2VPN services Get paginated list of all L2VPN services	GET /api/v1/vpn/l2vpn/services
Create L2VPN service Create L2VPN service for a given logical router	POST /api/v1/vpn/l2vpn/services
Delete a L2VPN service Delete a specific L2VPN service. If there are any L2VpnSessions on this L2VpnService, those needs to be deleted first.	DELETE /api/v1/vpn/l2vpn/services/<l2vpn-service-id>
Get L2VPN service Get a specific L2VPN service	GET /api/v1/vpn/l2vpn/services/<l2vpn-service-id>
Edit a L2VPN service Edit a specific L2VPN service	PUT /api/v1/vpn/l2vpn/services/<l2vpn-service-id>
Get all L2VPN sessions Get paginated list of all L2VPN sessions	GET /api/v1/vpn/l2vpn/sessions
Create L2VPN session Create L2VPN session and bind to a L2VPNService	POST /api/v1/vpn/l2vpn/sessions
Delete a L2VPN session Delete a specific L2VPN session. If there are any logical switch ports attached to it, those needs to be deleted first.	DELETE /api/v1/vpn/l2vpn/sessions/<l2vpn-session-id>
Get a L2VPN session Get a specific L2VPN session	GET /api/v1/vpn/l2vpn/sessions/<l2vpn-session-id>
Edit a L2VPN session Edit a specific L2VPN session	PUT /api/v1/vpn/l2vpn/sessions/<l2vpn-session-id>
Get peer codes for the L2VpnSession Get peer codes for the L2VPN session to program the remote side of the tunnel.	GET /api/v1/vpn/l2vpn/sessions/<l2vpn-session-id>/peer-codes
Get L2VPN session remote mac for logical switch Get L2VPN session remote mac for logical switch.	GET /api/v1/vpn/l2vpn/sessions/<session-id>/remote-mac
Get L2VPN session statistics Get statistics of a L2VPN session. Query parameter source=realtime is the only supported source.	GET /api/v1/vpn/l2vpn/sessions/<session-id>/statistics
Get L2VPN session status Aggregated status of L2VPN session. Query parameter source=realtime\|cached is supported.	GET /api/v1/vpn/l2vpn/sessions/<session-id>/status
Get status summary of all existing L2VPN sessions. Load all the existing L2VPN sessions and return the status summary of all L2VPN sessions. Query parameter source supports only cached mode.	GET /api/v1/vpn/l2vpn/sessions/summary
Cumulative statistics for one IKE service instance Cumulative statistics for one IKE service instance. Query parameter source supports only cached mode.	GET /api/v1/vpn/services/<service-id>/summary

Management Plane API > Networking

Associated URIs:

List All Bridge Clusters

Create a Bridge Cluster

Delete a Bridge Cluster

Get Information about a bridge cluster

Update a Bridge Cluster

Returns status of a specified Bridge Cluster

List All Bridge Endpoint Profiles

Create a Bridge Endpoint Profile

Delete a Bridge Endpoint Profile

Get Information about a bridge endpoint Profile

Update a Bridge Endpoint Profile

List All Bridge Endpoints

Create a Bridge Endpoint

Delete a Bridge Endpoint

Get Information about a bridge endpoint

Update a Bridge Endpoint

Returns statistics of a specified Bridge Endpoint

Returns status of a specified Bridge Endpoint

List All DHCP Relay Profiles

Create a DHCP Relay Profile

Delete a DHCP Relay Profile

Read a DHCP Relay Profile

Update a DHCP Relay Profile

List all DHCP Relay Services

Create a DHCP Relay Service

Delete a DHCP Relay Service

Read a DHCP Relay Service

Update a DHCP Relay Service

Get a paginated list of DHCP server profiles

Create a DHCP server profile

Delete a DHCP server profile

Get a DHCP server profile

Update a DHCP server profile

Reallocate edge cluster and members of given DHCP profile.

Get a paginated list of DHCP servers

Create a DHCP server

Delete a DHCP server

Get a DHCP server with v4 and/or v6 servers

Update a DHCP server with v4 and/or v6 servers

Get a paginated list of a DHCP server's IP pools

Create an ip pool for a DHCP server

Delete a DHCP server's IP pool

Get a DHCP server's IP pool with the specified pool ID

Update a DHCP server's IP pool

Get the realized state of a dhcp ip pool

Get a paginated list of a DHCP IPv6 server's IP pools

Create an ip pool for a DHCP IPv6 server

Delete a DHCP IPv6 server's IP pool

Get a DHCP IPv6 server's IP pool with the specified pool ID

Update a DHCP IPv6 server's IP pool

Get a paginated list of a DHCP IPv6 server's static bindings

Create a static binding for a DHCP IPv6 server

Delete a static binding for DHCP IPv6 server

Get a DHCP IPv6 server's static binding with the specified binding ID

Update a DHCP IPv6 server's static binding

Delete a single DHCP lease entry specified by ip and mac.

Get the realized state of a dhcp server

Get a paginated list of a DHCP server's static bindings

Create a static binding for a DHCP server

Delete a static binding

Get a DHCP server's static binding with the specified binding ID

Update a DHCP server's static binding

Get the realized state of a dhcp static binding

Get DHCP service status with given dhcp server id

Get a paginated list of DNS forwarders

Create a DNS forwader

Delete a specific DNS forwarder

Retrieve a DNS forwarder

Clear the current cache of the DNS forwarder.

Enable the DNS forwarder.

Disable the DNS forwarder.

Update a specific DNS forwarder

Get the recent failed DNS queries

Resolve a given address via the DNS forwarder

Get the realized state of a DNS forwarder

Get current status of the given DNS forwarder

Read All IPV6 DADProfiles

Create a new DADProfile