API Reference
REST API reference for authentication, devices, templates, stacks, tasks, and error codes.
6 articles
Authentication
Authenticate with the NetStacks Controller API using JWT access and refresh tokens, local/LDAP/OIDC providers, sessions, and rate limiting.
Devices API
REST CRUD for managed network devices: list, create, update, delete, bulk import, NetBox sources, enrichment reads, and credential testing.
Templates API
Create, render, and version config templates via /api/config/templates with automatic variable extraction powered by the MiniJinja engine.
Stacks API
Combine config templates into deployable stacks, create instances with per-device overrides, deploy to devices, and roll back via the REST API.
Tasks API
Schedule, run, and cancel automated tasks (config backups and AI agent tasks) with cron-based scheduling, timezones, and retries.
Error Codes
Reference for NetStacks API errors: the flat JSON error shape, every HTTP status code returned, rate-limit responses, and copy-paste handling examples.
Need Help?
Can't find what you're looking for? Browse all documentation or get in touch.