Endpoints
Endpoints represent the IP Fabric API paths from which the plugin retrieves data during synchronization. Each endpoint corresponds to a specific table in IP Fabric, such as device inventory, site information, or network configuration data. Endpoints serve as the data source definition in Transform Maps, which specify how IP Fabric data is transformed into NetBox objects.
Understanding Endpoints
Endpoints are a foundational component of the plugin’s data synchronization architecture. They define the specific IP Fabric API paths that will be queried when collecting data. For example, the endpoint /inventory/devices retrieves device information, while /technology/vlans/site-summary retrieves VLAN data.
During a sync, the plugin:
- Identifies which endpoints are needed based on the enabled Transform Maps and Sync parameters.
- Combines all Filters associated with each endpoint to create the final query parameters.
- Retrieves data from IP Fabric using the endpoint path and combined filters.
- Transforms the retrieved data according to the Transform Map configuration.
Parameters
| Field | Description | Type |
|---|---|---|
| Name | Descriptive name of the endpoint (e.g., “Devices Endpoint”) | CharField |
| Description | Optional description providing additional context about the endpoint | TextField |
| Endpoint | IP Fabric API path in URL notation (e.g., /inventory/devices) |
CharField |
Read-Only Model
Endpoints are read-only and cannot be manually created, edited, or deleted through the NetBox UI or API. They are automatically populated during installation via Django migrations from a predefined configuration file (endpoint.json). This ensures consistency across installations and prevents accidental modification of critical data source definitions.
Available Endpoints
The plugin includes the following pre-configured endpoints for IP Fabric data synchronization:
| Endpoint Name | Endpoint Path | Description |
|---|---|---|
| Default Sites Endpoint | /inventory/sites/overview |
Site inventory and overview data |
| Default Devices Endpoint | /inventory/devices |
Device inventory data |
| Default Stack Members Endpoint | /technology/platforms/stack/members |
Stack (virtual chassis) members |
| Default VSS Chassis Endpoint | /technology/platforms/vss/chassis |
VSS (Virtual Switching System) chassis |
| Default Interfaces Endpoint | /inventory/interfaces |
Interface inventory data |
| Default Part Numbers Endpoint | /inventory/part-numbers |
Inventory items and part numbers |
| Default VLANs Endpoint | /technology/vlans/site-summary |
VLAN configuration summary |
| Default VRFs Endpoint | /technology/routing/vrf/detail |
VRF routing table details |
| Default Networks Endpoint | /technology/networks/managed-networks |
Network prefix information |
| Default Managed IPv4 Endpoint | /technology/addressing/managed-ip/ipv4 |
IPv4 address management data |
For detailed information about how data from these endpoints maps to NetBox models, see the Data Mapping documentation.
Relationships with Other Models
Transform Maps
Each Transform Map references a single endpoint via the source_endpoint foreign key field. This relationship defines which IP Fabric table will provide the source data for transformation into a specific NetBox model.
Filters
Endpoints can be associated with multiple Filters through a many-to-many relationship. When a sync runs, all filters associated with an endpoint are combined to create the final query parameters sent to the IP Fabric API.
This method on the endpoint model merges:
- All filter expressions from associated filters (grouped by type: AND/OR).
- Site filters from the sync configuration parameters (added to AND group).
This combined filter is then used as the final filter when querying the IP Fabric API for that specific endpoint, ensuring that only relevant data is retrieved during synchronization.
The Show Filters button in endpoint list shows all filters associated with the endpoint. They will be combined the same way when the endpoint is queried during a sync operation given the sync has all existing filters for this endpoint assigned. This excludes filters specific to a sync’s site selection.
Viewing Endpoint Details
To view endpoint details, navigate to Plugins → IP Fabric → Endpoints. The endpoint detail page displays:
- Endpoint name, description, and API path.
- Related Transform Maps using this endpoint.
- Associated Filters that apply to this endpoint.
