Getting Started

This page will help you get started with the Snapt Nova API.

Welcome to the Snapt Nova developer API documentation portal.

On the left you will find the full API specification, and be able to test the various commands with a valid API key. All Snapt Nova API authentication is JWT-based, aka Bearer Tokens, and you must create a token on the Nova Portal.

Testing The API

To test your token and your API access we recommending a simple Node list command using curl. Below is an example of how to retrieve a list of Nodes with your API credentials. You will replace the "XXXXXXX" value with your API token.

curl --request GET \
     --url \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer XXXXXXXX'

Note on Deployments

In the user interface ADC deployments happen automatically - the changes you make to an ADC, WAF profile, and so on are automatically applied to any Nodes that are attached.

With the API you must trigger a deployment using the ADC Deployments endpoints to apply changes. Otherwise your templates will not be deployed to your Nodes.

This allows you to batch multiple changes and do a single deploy, as opposed to triggering 50 deploys for 50 changes.

Getting Support

Paying Snapt Nova clients have support, and may request assistance with any API issues using the support site. You may find various resources and support options on the Help Portal.