NSX-T Data Center REST API

List DHCP relay config instances

Paginated list of all DHCP relay config instances
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/global-infra/dhcp-relay-configs
/policy/api/v1/infra/dhcp-relay-configs
Request Headers:
n/a
Query Parameters:
PolicyListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/dhcp-relay-configs

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
DhcpRelayConfigListResult+

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [ { "resource_type": "DhcpRelayConfig", "id": "dhcp-relay1", "display_name": "dhcp-relay1", "path": "/infra/dhcp-relay-configs/dhcp-relay1", "parent_path": "/infra", "relative_path": "dhcp-relay1", "server_addresses": [ "10.1.1.1", "10.1.1.2" ] "_create_user": "admin", "_create_time": 1516668826912, "_last_modified_user": "admin", "_last_modified_time": 1516668826912, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ] }

Required Permissions:

read

Feature:

policy_dhcp

Additional Errors: