Skip to main content

Get DHCP Server for Tenant on Site (v2.2)



List the DHCP server for a tenant on a site.


Path Parameters

    site_id stringrequired

    ID of the site. More details on the site can be retrieved by querying the sites API.

    dhcp_server_id stringrequired

    ID of the DHCP server.


Successful Operation

    address_family stringrequired

    Possible values: [IPV4, IPV6]

    The DHCP config address values.

    broadcast_address string

    The address of the site.

    custom_options CustomDHCPOptions[]

    Custom options defined for the DHCP server.

  • Array [
  • option_definition stringrequired

    Custom option definition. Max length supported is 1024.

    option_value stringrequired

    Custom option value. Max length supported is 8192.

    vendor_class_identifier string

    Vendor Class Identifier

  • ]
  • default_lease_time int64

    The lease time each client will get if a user does not request a particular lease time.


    Description of each instance of the DHCP server, per subnet.

    disabled boolean

    Uncheck to enable the configuration.

    dns_servers string[]

    The domain name servers for clients to resolve DNS requests. Max number is 3.

    domain_name string

    The domain name for clients. Max length is 256.

    gateway string

    The default gateway for clients.

    id string

    The DHCP server ID.

    ip_ranges IPRange[]required

    The valid IPv4 address range for defined subnet.

  • Array [
  • end_ip stringrequired

    The original end IP address for the defined subnet.

    start_ip stringrequired

    The original start IP address for the defined subnet.

  • ]
  • max_lease_time int64

    The maximum lease time the clients can use.

    network_context_id string

    ID of the network context, if configured.

    static_mappings StaticMappingV2[]

    IP addresses assigned to clients by statically mapping IPs to MAC addresses of the clients.

  • Array [
  • client_duid string

    Client Duid: Pattern(error = DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_DUID: Invalid Client duid provided for static mapping., regexp = ([0-9a-fA-F]{1,2}:)[0-9a-fA-F]{1,2}|([0-9a-fA-F]{1,2}:)(:([0-9a-fA-F]{1,2}:))([0-9a-fA-F]{1,2}))

    ip_address stringrequired

    Ip Address: NotNull(error = DHCPSERVER_CONFIG_STATIC_MAPPING_MISSING: Provide all required attributes for static mappings.)

    mac string

    Mac: MACAddressFiveColons(error = DHCPSERVER_CONFIG_INVALID_STATIC_MAPPING_MAC_ADDR: Invalid mac address provided for static mapping)

    name stringrequired

    Name: NotNull(error = DHCPSERVER_CONFIG_STATIC_MAPPING_MISSING: Provide all required attributes for static mappings.) Size(max = 256, error = DHCPSERVER_CONFIG_STATIC_MAPPING_NAME_EXCEEDS_LIMIT: Static Mapping name execeeds the maximum limit, min = 0) Pattern(error = DHCPSERVER_CONFIG_STATIC_MAPPING_UNSUPPORTED_NAME: Provide valid static mapping name, regexp = ^[a-zA-Z0-9]+(([a-zA-Z0-9\-_])|(\.?[a-zA-Z0-9\-]))*\.?$)

  • ]
  • subnet stringrequired

    The subnet for which the DHCP server is being configured.

    tags string[]

    An information field that can be added to identify the DHCP server.