Integrations & API Resources
How NetStacks Terminal connects to external systems: API Resources, the built-in NetBox, LibreNMS and Netdisco integrations, and using any REST API through Quick Calls, Enrichment and MOP steps.
Overview
Most connections from NetStacks Terminal to other systems, such as NetBox, LibreNMS, Netdisco or your own REST APIs, go through one building block: the API Resource.
- An API Resource is how to reach a system: a base URL plus authentication. Its credentials are kept in your vault.
- An Integration (NetBox, LibreNMS, Crawler) knows what to do with a particular system, such as importing devices or pulling neighbour data. It uses an API Resource to connect.
This page describes the standalone Terminal. In enterprise mode, integrations are managed on the Controller (see below).
Next to these settings you'll find small Ask AI buttons. They open the assistant with a prompt that explains the concept and walks you through setup. You can turn them off in Settings → AI (Contextual "Ask AI" help).
API Resources
API Resources live in the API section of the Workspaces sidebar (activity bar → Workspaces), not in Settings. You can also get there from the command palette with API Client…. Each resource is listed with the saved requests that use it.
An API Resource holds:
| Field | What it is |
|---|---|
| Name | A label, for example “NetBox Production” |
| Base URL | For example https://netbox.example.com |
| Test Path (optional) | The path Test Connection requests; / if blank |
| Authentication → Type | No Auth, Bearer Token, Basic Auth (username/password), API Key Header (header name + key), Custom Header, or Multi-Step Auth (log in with one or more requests and pull a token out of the response) |
| Post-Auth Headers / Default Headers | Extra headers sent with every request |
| Advanced | TLS certificate verification on/off and a Timeout (sec) |
Tokens, passwords and keys are encrypted in the vault. When you edit a resource, leave a secret field blank to keep the stored value.
Adding an API Resource
- Click Workspaces in the activity bar and open the API section.
- Click + Add API resource. The Add API Resource dialog opens.
- Fill in Name, Base URL and, if useful, a Test Path (for NetBox,
/api/works well). - Choose the authentication Type the system expects and enter the credential. Use Custom Header for schemes like
Authorization: Token <token>; enter the token as Credential / Token and reference it as{{token}}in Post-Auth Headers. - Click Test Connection, then save.
You can now send requests through this resource from the API client, and other features can pick it from their own API Resource drop-downs.
Built-in Integrations
Integration sources are set up in Settings → Integrations. Each source points at an API Resource.
| Integration | What it does |
|---|---|
| NetBox (NETBOX SOURCES) | Imports NetBox devices as ready-to-connect sessions. You can filter by site, role, vendor, platform, status and tag, and map credential profiles and CLI flavors. It also supplies data for topology, enrichment and discovery lookups. Imports run when you click Sync. They add new devices and leave existing sessions as they are. See NetBox Integration. |
| LibreNMS (LIBRENMS SOURCES) | Pulls devices, CDP/LLDP links and live port statistics for topology maps and link utilisation, and looks up traceroute hops. It does not create sessions. |
| NetStacks-Crawler (NETSTACKS-CRAWLER SOURCES) | The Crawler integration is NetStacks' interface to a Netdisco server (it uses Netdisco's REST API). It provides MAC, port, device and neighbour lookups for topology enrichment, hover enrichment and traceroute. Point it at your existing Netdisco; there is nothing extra to deploy. It does not create sessions. |
The same tab has the import and export tools (sessions to and from file, and Import from SecureCRT) and Backup & Seed.
Using Any Other REST API
A system doesn't need a built-in integration to be useful. Create an API Resource for it (SolarWinds, PRTG, a CMDB, an IPAM, your own service) and use it from:
- Saved requests and Quick Calls: save a request (method, path, headers, body, and optionally a JSON path to extract) under the resource. Then run it from the status bar's Calls menu. Placeholders such as
{{hostname}}are asked for when you run it. See Quick Calls. - Enrichment: add a source in Settings → Enrichment that looks up hovered IPs, MACs or interfaces through the resource. See Hover Enrichment.
- MOP steps: an API step in a Method of Procedure can call the resource as part of a change. See Methods of Procedure.
- The AI assistant: the AI can list your API Resources and call them as a tool while it works.
Saved requests can be shared as a JSON file (Share… / Import requests…). Credentials are never included in the file.
With a Controller Enterprise
In enterprise mode, the Terminal's Integrations settings tab and the Workspaces API section are hidden. External systems are connected once, centrally, on the Controller. Administrators use the admin console's Integrations section (API Resources, Connectors, Enrichment). Devices come from the Controller's inventory, which can be filled from NetBox, CSV/JSON import or discovery.
Troubleshooting
Test Connection fails with a certificate error
If the system uses a self-signed certificate, turn off TLS verification under Advanced, or install its CA in your operating system's trust store.
401 or 403 responses
Check the authentication type and header format the system expects. Then re-enter the secret; a blank secret field keeps the old value.
NetBox devices are skipped on import
Devices without a primary IP, or with no matching credential profile, are skipped. The import report lists them under Skipped and Errored.