Overview

The following API endpoints are available in IP Fabric. Descriptions and allowed methods are coming soon. For more information about IP Fabric API, please visit generated IP Fabric API documentation.

API Blog Posts

Please take a look at the following blog posts about using the IP Fabric API and Python SDK:

• Part 1: The Basics Explains creating an API token, finding the API documentation, and retrieving data using Python requests which can be translated into other coding languages.
• Part 2: Python Utilizing the official IP Fabric Python SDK to retrieve data.
• Part 3: Webhooks Creating Webhooks to further your automation journey based on IP Fabric events.
• Part 4: Diagramming Utilizing the official IP Fabric Python Diagramming SDK to automate creation of Network and Path Lookup Diagrams.

Technology Table Endpoints

The technology tables use POST requests only for reading information and the payload is used to specify or filter requested data from listed tables. The POST & DELETE request can be used for Intent verification rules at each endpoint. At every technology table, search for the question mark button that exposes the endpoints (can be used with filters as well).

Payload definition

{
  columns:[],
  filters:{},
  pagination:{},
  snapshot:"snapshotID",
  reports:""
}

• columns -- specifies columns that we request for the endpoint
• filters -- filtering options, for any column or intent verification {"vendor":["like","cisco"],"family":["eq","lap"],"reload":["color","eq","0"]}(optional)
• pagination - specifies the pagination and response limits {"limit":26,"start":0} (optional)
• snapshot -- defines snapshot ID or we can use: $last, $prev, $lastlocked
• reports -- Intent rules definition (optional)

For more information, please, see Request payload in generated API documentation.