Skip to main content

API guides

The NetFoundry REST API lets you automate everything you can do in the console—create networks, manage identities and services, configure policies, and integrate NetFoundry into your own tooling and workflows. These guides are aimed at DevOps practitioners building automation and integrations, not end users of the platform.

What you can do​

Every action available in the console maps directly to an API call. Common automation use cases include:

  • Allowing or blocking a device based on compliance state or an external event
  • Onboarding a new device to connect to a specific service
  • Creating a path to a new service for an existing group of identities
  • Triggering actions in response to metrics or events that NetFoundry reports

REST conventions​

The API follows standard REST conventions. All request and response bodies are JSON. Requests that include a body must send a Content-Type: application/json header, and responses with a body include it too.

See the API reference for the full endpoint and schema documentation.