v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB

Interfaces

List all Interfaces

get/api/v1/if-entries

Query parameters

host_idstring uuid nullable

Filter by host ID

network_idstring uuid nullable

Filter by network ID

idsstring[] nullable

Filter by specific entity IDs (for selective loading)

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

atstring date-time nullable

As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.

Response

List of Interfaces

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "data": [
    {
      "cdp_address": "192.168.1.1",
      "lldp_mgmt_addr": "192.168.1.1",
      "mac_address": "a4:bb:6d:12:34:56"
    }
  ],
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.17.7"
  }
}