# Get DHCP Scope
## Endpoint
`/api/dhcp/scopes/get`
Obsolete path: `/api/getDhcpScope`
## Method
GET
## Description
Gets the complete details of a DHCP scope configuration, including all DHCP options, exclusions, reserved leases, static routes, vendor information, and generic options.
## Authentication
Required. Token must have **DhcpServer: View** permission.
## Parameters
| `token` | string | Yes | No | The session token generated by the `login` or the `createToken` call. |
| `name` | string | Yes | No | The name of the DHCP scope. |
## Response Fields
| `name` | string | The name of the DHCP scope. |
| `startingAddress` | string | The starting IP address of the scope's address range. |
| `endingAddress` | string | The ending IP address of the scope's address range. |
| `subnetMask` | string | The subnet mask of the network. |
| `leaseTimeDays` | integer | The lease time component in days. |
| `leaseTimeHours` | integer | The lease time component in hours. |
| `leaseTimeMinutes` | integer | The lease time component in minutes. |
| `offerDelayTime` | integer | The delay in milliseconds before sending a DHCPOFFER message. |
| `pingCheckEnabled` | boolean | Whether the server pings an IP before offering it to detect conflicts. |
| `pingCheckTimeout` | integer | The timeout in milliseconds to wait for a ping reply. |
| `pingCheckRetries` | integer | The maximum number of ping requests to try. |
| `domainName` | string | The domain name for the network (DHCP Option 15). |
| `domainSearchList` | array of strings | List of domain names clients can use as search suffixes (DHCP Option 119). |
| `dnsUpdates` | boolean | Whether the DHCP server automatically updates forward and reverse DNS entries. |
| `dnsOverwriteForDynamicLease` | boolean | Whether the server overwrites existing DNS A records for dynamic leases. |
| `dnsTtl` | integer | The TTL value in seconds used for forward and reverse DNS records. |
| `serverAddress` | string | The IP address of the next server (TFTP) for bootstrap (siaddr). |
| `serverHostName` | string | The bootstrap server host name for TFTP (sname/Option 66). |
| `bootFileName` | string | The boot file name on the TFTP server (file/Option 67). |
| `routerAddress` | string | The default gateway IP address (DHCP Option 3). |
| `useThisDnsServer` | boolean | Whether to use this DNS server's IP for clients' DNS configuration. |
| `dnsServers` | array of strings | List of DNS server IP addresses (DHCP Option 6). |
| `winsServers` | array of strings | List of NBNS/WINS server IP addresses (DHCP Option 44). |
| `ntpServers` | array of strings | List of NTP server IP addresses (DHCP Option 42). |
| `staticRoutes` | array of objects | List of static route entries (DHCP Option 121). |
| `staticRoutes[].destination` | string | The destination network address. |
| `staticRoutes[].subnetMask` | string | The subnet mask for the destination network. |
| `staticRoutes[].router` | string | The router/gateway address for the route. |
| `vendorInfo` | array of objects | List of vendor-specific information entries. |
| `vendorInfo[].identifier` | string | The vendor class identifier expression. |
| `vendorInfo[].information` | string | The vendor-specific information as a colon-separated hex string. |
| `capwapAcIpAddresses` | array of strings | List of CAPWAP Access Controller IP addresses (DHCP Option 138). |
| `tftpServerAddresses` | array of strings | List of TFTP server addresses (DHCP Option 150). |
| `genericOptions` | array of objects | List of custom DHCP option entries. |
| `genericOptions[].code` | integer | The DHCP option code number. |
| `genericOptions[].value` | string | The option value as a colon-separated hex string. |
| `exclusions` | array of objects | List of IP address range exclusions. |
| `exclusions[].startingAddress` | string | The starting IP address of the excluded range. |
| `exclusions[].endingAddress` | string | The ending IP address of the excluded range. |
| `reservedLeases` | array of objects | List of reserved lease entries. |
| `reservedLeases[].hostName` | string or null | The hostname override for the client, or `null`. |
| `reservedLeases[].hardwareAddress` | string | The MAC address of the client (dash-separated). |
| `reservedLeases[].address` | string | The reserved IP address. |
| `reservedLeases[].comments` | string | Comments for the reservation entry. |
| `allowOnlyReservedLeases` | boolean | Whether dynamic allocation is disabled, only reserved leases are assigned. |
| `blockLocallyAdministeredMacAddresses` | boolean | Whether to block dynamic allocation for locally administered MAC addresses. |
| `ignoreClientIdentifierOption` | boolean | Whether to always use the client's MAC address instead of Option 61 for lease identification. |
## Conditional Logic Notes
- None for this read-only endpoint. All fields are returned for every scope.
## Edge Cases
- `hostName` in `reservedLeases` can be `null`.
- `serverAddress`, `serverHostName`, and `bootFileName` may be empty strings when not configured.
- Array fields (`dnsServers`, `winsServers`, `ntpServers`, `staticRoutes`, `vendorInfo`, `capwapAcIpAddresses`, `tftpServerAddresses`, `genericOptions`, `exclusions`, `reservedLeases`, `domainSearchList`) may be empty arrays or potentially absent if never configured.
- The `hardwareAddress` in `reservedLeases` uses dash separators (`-`) in the response.