Aviatrix Postman API Guide
Intro:
• This guide will demonstrate how to setup a Postman environment and call Aviatrix APIs.
• If you already have Postman downloaded and your environment setup, skip to step 4.
Step 1: Download Postman
• Visit [Link] and download the app (not the web version).
Step 2: Launch Postman and Setup your Environment
• Launch Postman
o Creating an account/logging in is not needed
• Turn off SSL Certificate verification
o Mac: Postman -> Preferences -> General -> SSL certificate verification -> Off
o Windows: File -> Settings -> General -> SSL certificate verification -> Off
• Create your environment
o Click on the eye icon in the upper right corner
o Click “Add” in the “Environment” section
o Name your environment
o Add “controller_hostname”, “username” and “password” to the VARIABLE column
o Fill out the values in in the CURRENT VALUE column
§ controller_hostname: <your controllers public IP>
§ username: <login username>
§ password: <login password>
o Click “Save”
Step 3: Import the latest Postman JSON
• Download the JSON file in Aviatrix Sharepoint -> API Postman Documentation folder
• In Postman, click “Import” in the upper left corner
• Under “File” either drag and drop the downloaded JSON or click “Upload Files” and select
the downloaded JSON
• After uploading, click “Import”
Step 4: Login into Controller and Get CID
• Under Collections -> Aviatrix API Documentation -> Initial Setup, select “Log into Controller
& Get CID”
• Make sure that you have the correct environment selected
• Click “Send”
o A successful return will automatically store the CID into your environment variables
Step 5: Calling APIs
• Select an API to call
• If needed, change parameter values in the VALUE column
o Information regarding a parameter (required/optional, valid values) can be found in
the DESCRIPTION column
• Click “Send” and view the API response at the bottom
o An example output is provided under the selected API