> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/switch-infrastructure/config-manager/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/switch-infrastructure/config-manager/_mcp/server.

# List Leases

GET /lease

Return a cursor-paginated, optionally filtered page of normalized leases.

Reference: https://docs.nvidia.com/switch-infrastructure/config-manager/services/dhcp/dhcp-api/list-leases-lease-get

## Authentication

- `Authorization` header (bearer token, required) — Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

## Request

### Query parameters

- `ip_version` (enum, optional) — Supported DHCP address families.
  - Allowed values: `4`, `6`
- `limit` (integer, optional, default: 100)
- `cursor` (string, optional, nullable)
- `search` (string, optional, nullable)
- `subnet` (string, optional, nullable)

## Response

### 200

Successful Response

- `leases` (list of object, required)
  - `cltt` (integer, required)
  - `expires_at` (datetime, required, nullable)
  - `ip_address` (string, required)
  - `state` (integer, required)
  - `valid_lft` (integer, required)
  - `client_id` (string, optional, nullable)
  - `duid` (string, optional, nullable)
  - `hostname` (string, optional, default: )
  - `hw_address` (string, optional, nullable)
  - `subnet` (string, optional, nullable)
- `next_cursor` (string, optional, nullable)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "leases": [
    {
      "cltt": 1700000000,
      "expires_at": "2024-01-15T09:30:00Z",
      "ip_address": "192.168.1.45",
      "state": 2,
      "valid_lft": 3600,
      "client_id": "client-12345",
      "duid": "00:01:00:01:23:45:67:89:ab:cd:ef:01:23:45",
      "hostname": "office-printer-01",
      "hw_address": "00:1A:2B:3C:4D:5E",
      "subnet": "192.168.1.0/24"
    }
  ],
  "next_cursor": "eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiIyMDIzLTEyLTAxVDA5OjMwOjAwWiJ9"
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/lease"

querystring = {"cursor":"eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0=","ip_version":"4","limit":"100","search":"hostname:printer","subnet":"192.168.1.0/24"}

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.example.com/lease?cursor=eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0%3D&ip_version=4&limit=100&search=hostname%3Aprinter&subnet=192.168.1.0%2F24';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/lease?cursor=eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0%3D&ip_version=4&limit=100&search=hostname%3Aprinter&subnet=192.168.1.0%2F24"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/lease?cursor=eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0%3D&ip_version=4&limit=100&search=hostname%3Aprinter&subnet=192.168.1.0%2F24")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/lease?cursor=eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0%3D&ip_version=4&limit=100&search=hostname%3Aprinter&subnet=192.168.1.0%2F24")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/lease?cursor=eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0%3D&ip_version=4&limit=100&search=hostname%3Aprinter&subnet=192.168.1.0%2F24', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/lease?cursor=eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0%3D&ip_version=4&limit=100&search=hostname%3Aprinter&subnet=192.168.1.0%2F24");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/lease?cursor=eyJsaW1pdCI6MTAwLCJjdXJzb3IiOiJmNjY3YjY3YS1hYmNkLWU4ZjMtOWY4Mi1hYmNkZWY4NzY1NDMyIn0%3D&ip_version=4&limit=100&search=hostname%3Aprinter&subnet=192.168.1.0%2F24")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```