netLD API HowTo

Search Inventory with Code

This example shows the basic netLD API flow: authenticate with an API key, send a JSON-RPC request to Inventory.search, and print the returned devices. Each language uses a small netld_example_client helper so the search script stays readable.

Before You Start

Python 3.10 or newer, with the requests and python-dotenv packages
Node 20 or newer, with the dotenv package
PowerShell 7 or newer
A netLD or ThirdEye URL with API access enabled
A valid API key
The network name to search, commonly Default

Create a Local `.env` File

Keep credentials out of source code. Put the API URL, API key, network, and search parameters in a local .env file that is not committed to source control.

NETLD_BASE_URL="https://netld.example.com"
NETLD_API_KEY="replace-with-your-api-key"
NETLD_NETWORK="Default"
NETLD_SEARCH_SCHEME="ipAddress"
NETLD_SEARCH_QUERY="10.95.1.0/24"

Example helper

The Client File Is Reusable Example Code

These examples include a small netld_example_client helper to handle login, sessions, JSON-RPC formatting, redirects, and errors. It is example code, not a supported SDK package. Use it as a starting point, then adapt it to your team’s automation standards.

Example: Search for Devices

Download the example bundle for your language. Each bundle includes the short search script, the matching example client, and a .env.example template. The search script is the part you edit for different searches.

Download Python Example Bundle

import os

from netld_example_client import NetLDClient, print_devices


client = NetLDClient.from_env()
client.login()

page_data = client.search_inventory(
    networks=[os.environ.get("NETLD_NETWORK", "Default")],
    schemes=os.environ.get("NETLD_SEARCH_SCHEME", "ipAddress"),
    queries=os.environ.get("NETLD_SEARCH_QUERY", "10.95.1.0/24"),
)

print_devices(page_data)

Run It

python -m pip install requests python-dotenv
python search_inventory.py

Download Node.js Example Bundle

import "dotenv/config";

import { NetLDClient, printDevices } from "./netld-example-client.mjs";

const client = NetLDClient.fromEnv();
await client.login();

const pageData = await client.searchInventory({
  networks: [process.env.NETLD_NETWORK || "Default"],
  schemes: process.env.NETLD_SEARCH_SCHEME || "ipAddress",
  queries: process.env.NETLD_SEARCH_QUERY || "10.95.1.0/24",
});

printDevices(pageData);

Run It

npm install dotenv
node search-inventory.mjs

Download PowerShell Example Bundle

param(
    [string]$EnvPath = "$PSScriptRoot/.env"
)

. "$PSScriptRoot/NetLDExampleClient.ps1"

Import-DotEnv -Path $EnvPath

$baseUrl = $env:NETLD_BASE_URL
$apiKey = $env:NETLD_API_KEY
$network = if ($env:NETLD_NETWORK) { $env:NETLD_NETWORK } else { "Default" }
$searchScheme = if ($env:NETLD_SEARCH_SCHEME) { $env:NETLD_SEARCH_SCHEME } else { "ipAddress" }
$searchQuery = if ($env:NETLD_SEARCH_QUERY) { $env:NETLD_SEARCH_QUERY } else { "10.95.1.0/24" }
$debugMode = $env:NETLD_DEBUG -eq "1"

if (-not $baseUrl) {
    throw [NetLDError]::new("Set NETLD_BASE_URL in .env before running this example.")
}

if (-not $apiKey) {
    throw [NetLDError]::new("Set NETLD_API_KEY before running this example.")
}

$client = [NetLDClient]::new($baseUrl, $apiKey, 10, $debugMode)
$client.Login()

$pageData = $client.SearchInventory(
    @($network),
    @($searchScheme),
    @($searchQuery),
    0,
    100,
    "ipAddress",
    $false
)

Show-Devices -PageData $pageData

Run It

pwsh -File ./search-inventory.ps1

Example Output

Login status=200
Returned 3 of 3 matching devices
10.95.1.12      core-switch-01                 Cisco::IOS
10.95.1.13      core-switch-02                 Cisco::IOS
10.95.1.44      branch-fw-01                   PaloAlto::PANOS

Try Other Searches

Change the search scheme and query to search by a different supported inventory field.

NETLD_SEARCH_SCHEME="hostname"
NETLD_SEARCH_QUERY="core-switch"

Common Gotchas

What to Check If It Fails

Redirects usually mean the request is being sent through an SSO/browser-login path.
Inventory.search expects search text with a trailing newline.
The network parameter is passed as a list, even for one network.
Set NETLD_DEBUG=1 to print JSON-RPC request and response payloads.

Back to netLD API overview

Before You Start

Create a Local .env File

The Client File Is Reusable Example Code

Example: Search for Devices

Run It

Run It

Run It

Example Output

Try Other Searches

What to Check If It Fails

30 Day Free Trial

Create a Local `.env` File