Introduction to the Forward Networks API

As organizations scale their networks, automation and integration with existing tools become essential. Forward Networks provides a robust API that allows users to streamline bulk actions, automate workflows, and extract valuable data for reporting and analysis. In this article, we introduce the Forward Networks API, covering its basic functionalities, common use cases, and how customers can leverage it for their network operations.

What is an API?

API stands for Application Programming Interface. It acts as a bridge that enables different applications to communicate with each other. APIs provide a standardized way to interact with a system without needing to understand its underlying architecture. Essentially, APIs allow users to send requests and retrieve or modify data efficiently.

Why Use the Forward Networks API?

The Forward Networks API is a powerful tool for managing devices, automating tasks, and integrating with other network management solutions. Some key use cases include:

• Bulk device onboarding: Instead of manually adding devices through the GUI, users can automate the process by submitting a POST request to import multiple devices at once.
• Automation & network updates: The API enables administrators to dynamically update network configurations, reducing manual effort and ensuring consistency.
• Integration with external tools: Many organizations use tools like ServiceNow CMDB to manage device information. The API allows seamless synchronization of network data across platforms.
• Reporting & data extraction: Users can extract device and snapshot data for custom reporting, audits, or compliance tracking.

Understanding API Requests

The Forward Networks API supports multiple request types:

• GET: Retrieve information, such as device inventories or network snapshots.
• POST: Add new data, such as uploading device credentials.
• PATCH/PUT: Modify existing records, like updating device information.
• DELETE: Remove data when necessary.

Exploring the API Through Documentation

Users can explore and test API endpoints directly in the Forward Networks API documentation. On-prem customers can access the API documentation at https://*Your-Forward-App*/api-doc. The built-in API interface allows users to input credentials, execute queries, and view responses in real-time. Additionally, once a successful API call is executed, users can copy the corresponding cURL command or URL for use in scripts.

Let’s start with an easy API call…

Retrieving a List of Devices

1. Go to the Forward Networks API documentation 
2. Scroll down the Documentation page to the Credentials form
       a.Provide your Username and Password or Access Key and Secret Key

   

3. Once you’ve provided credentials, we’ll start with an easy API call that will list the network devices in a snapshot. Continue scrolling down to the Networks section and expand the /api/networks API endpoint.

Let’s try something with more filtering options...

Filtering Snapshots for Reporting

You can limit results to specific snapshots based on success criteria. Filtering options can also exclude snapshots with missing devices. In the Networks section, and expand the /api/networks/{networkId}/snapshots API endpoint. Provide the network ID and any success criteria you’d like to apply to the query. 

You’re not limited to reading data, you can also make changes via the API…

Updating Device Credentials in Bulk

Instead of manually updating credentials for individual devices, users can submit a POST request with updated authentication details.  In the Networks section, and expand the /api/networks/{networkId}/deviceCredentials API endpoint. Provide the network ID and modify the values in the request body to suite your needs. 

Moving Toward Automation

The API provides a strong foundation for automation. By integrating with scripting languages like Python, users can build workflows that:

• Automate device discovery and credential updates.
• Query and analyze network snapshots for compliance.
• Merge snapshots for running path search queries across historical data.

The Forward Networks API empowers users to automate network tasks, improve efficiency, and enhance integration with external tools. Whether you are new to APIs or an experienced developer, leveraging the API can significantly enhance your network management capabilities. Stay tuned for more in-depth guides, including advanced API queries and automation examples!

What API examples would you like to see? Ask in the comments below!