Overview

Audience

This documentation is aimed at developers wishing to automate things they can already do with the NetFoundry Web Console. If you are looking for a general introduction to NetFoundry then the Support Hub or the main web site are also places you could begin.

Your Code, NetFoundry’s API

The API allows you to manage your AppWANs with your own code. You could program your AppWAN to

  • disallow a lost or non-compliant device from connecting,
  • allow a new device to connect to a service based on some event or condition,
  • create a path to a new network service for an existing group of devices, or
  • trigger an alert based on an unexpected metric that NetFoundry reports.

The Web Console

the NetFoundry Web Console is an implementation of the API and so may help to express the model of the API while you’re learning how to build an AppWAN. For example, you might inspect the HTTP requests sent from your browser if you’re unsure how to automate a particular action and need a hint for searching the API reference.

Representations

This RESTful API transacts meaningful HTTP verbs and request paths and parameters. Most types of requests and responses also have an HTTP document body which is always a JSON representation. Requests that include a JSON body must also include a header Content-Type: application/json, and responses with a JSON body will have this header too.

You’ll find the API definition and reference here.