Netbox

@tagur/netboxv2026.07.17.1· 9d agoMODELS

01README

Generic NetBox REST API integration model for swamp.

Works with any NetBox instance and any API endpoint. Fetches objects via the REST API and stores each as a separately addressable resource using the factory pattern — enabling CEL queries, cross-model composition, and drift detection via versioned snapshots.

Methods: sync (fetch all objects from an endpoint with pagination and filters), get (fetch a single object by ID).

Quick Start

swamp extension pull @tagur/netbox
swamp vault create local_encryption netbox
swamp vault put netbox NETBOX_TOKEN=<your-api-token>
swamp model create @tagur/netbox sites \
  --global-arg url=https://nsot.example.com \
  --global-arg 'token=${{ vault.get("netbox", "NETBOX_TOKEN") }}' \
  --global-arg endpoint=dcim/sites
swamp model method run sites sync
swamp data query 'modelName == "sites"' --select '{"name": name, "status": attributes.status}'

02Models1

@tagur/netboxv2026.07.17.1netbox.ts

Global Arguments

Argument	Type	Required	Description
url	string	yes	NetBox base URL (e.g. https://nsot.example.com)
token	string	yes	NetBox API token
endpoint	string	yes	REST API path relative to /api/ (e.g. dcim/sites, ipam/prefixes)
filters?	record	no	Query parameter filters (e.g. {region: 'amer', status: 'active'})
pageSize	number	yes	Results per page for paginated requests
caCert?	string	no	Optional PEM CA certificate for internal/self-signed TLS endpoints

fn sync(filters?: record)

Fetch all objects from the configured endpoint and store each as a resource. Supports pagination and filters. Writes a snapshot resource with sync metadata.