API Reference

The NetStacks Controller REST API: base URL, authentication, the built-in Swagger UI, conventions, permissions, and a map of the resource groups.

Log in to the NetStacks Controller API, send the bearer token, refresh it, and manage sessions. Covers local, LDAP, and OIDC login endpoints.

List, create, update, import, and delete devices in the NetStacks Controller inventory, plus sites and NetBox sources.

Manage NetStacks Controller connection profiles and their encrypted secrets (passwords, SSH keys, SNMP communities, API tokens) through the API.

Create, version, and render NetStacks Controller config templates through the API, and list the automation platforms they target.

Create config stacks, preview what they render per device, save instances, run deployments, follow their logs, and roll back through the NetStacks Controller API.

Pull device configurations, read stored versions, compare versions, and run backup snapshots across many devices with the NetStacks Controller API.

List, review, and approve Methods of Procedure (MOPs) and read MOP execution history through the NetStacks Controller API.

Create and manage NetStacks Controller scheduled tasks (backups, deployments, health checks, scripts, AI agent tasks), run them on demand, and read job history.

Manage NetStacks Controller users, roles, organizations, settings, and license, and read the audit log through the API.

The error format and HTTP status codes returned by the NetStacks Controller API, and how to handle them in scripts.