Skip to main content

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

List the DHCP server for a tenant on a site.

Path Parameters
    site_id string required

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

    dhcp_server_id string required

    ID of the DHCP server.


Successful Operation

    broadcast_address string

    The address of the site.

    custom_options CustomDHCPOptions[]

    Custom options defined for the DHCP server.

  • Array [
  • option_definition string required

    Custom option definition. Max length supported is 1024.

    option_value string required

    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 string required

    The original end IP address for the defined subnet.

    start_ip string required

    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 StaticMapping[]

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

  • Array [
  • ip_address string required

    IP addresses assigned mapped to MAC addresses of the clients.

    mac string

    The mac addresses that need to be mapped.

    name string required

    The name of the static mapping. Max length supported is 256.

  • ]
  • subnet string required

    The subnet for which the DHCP server is being configured.

    tags string[]

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