Update an Interface

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

host_id*string

The host this entity belongs to.

if_descr*string

SNMP ifDescr - interface description (e.g., GigabitEthernet0/1)

network_id*string

The network this entity belongs to.

admin_status?null|

cdp_address?|

Remote management IP from CDP (cdpCacheAddress). IPv4 or IPv6.

cdp_device_id?|

Remote device ID from CDP (typically hostname, locally unique)

cdp_platform?|

Remote platform from CDP (e.g., "Cisco IOS")

cdp_port_id?|

Remote port ID from CDP

fdb_macs?array<string>|

Bridge FDB: learned MAC addresses on this switch port. Single-MAC ports can be resolved to neighbor links server-side. Multi-MAC ports indicate uplinks where LLDP/CDP is the better source.

if_alias?|

SNMP ifAlias - user-configured description

if_index?|

SNMP ifIndex — stable identifier within device, where one was read.

None for a port learned from a neighbour's LLDP/CDP advertisement rather than from the device's own ifTable: the far end tells us the port exists and what it is called, never its index. 0 used to stand in for that, which is a real ifIndex on some agents and made "never read" indistinguishable from "read as zero".

Not the identity of the row. match_existing_interface tries (host_id, if_name) first and the live unique index is on that pair; the index tier only runs for a row that has one.

if_name?|

SNMP ifName - short interface name (e.g., Gi1/0/1)

if_type?|

SNMP ifType - IANAifType integer (6=ethernet, 24=loopback, etc.), where one was read.

None is unknown, never a type. Everything that filters on this must treat unknown as included — a port at the far end of a cable is physical by construction, and excluding it for lack of a number would drop the row from resolution and from the map.

ip_address_id?|

FK to IPAddress entity - this port's IP assignment (must be on same host). Old daemons send this as "interface_id".

lldp_chassis_id?null|||||||

lldp_mgmt_addr?|

Remote management IP from LLDP neighbor (lldpRemManAddr). IPv4 or IPv6.

lldp_port_desc?|

Remote port description from LLDP neighbor (lldpRemPortDesc)

lldp_port_id?null|||||||

lldp_sys_desc?|

Remote system description from LLDP neighbor (lldpRemSysDesc) - platform info

lldp_sys_name?|

Remote system name from LLDP neighbor (lldpRemSysName)

mac_address?string

MAC address, as discovered.

mac_address_source?|||||||||||||

How a discovered value reached us.

Every variant here has something that writes it. Sources with no producer are deliberately absent: a rung the applier can never see is a rung nothing can be tested against, and the tier decision is better made by whoever writes the reader than guessed in advance.

Do not derive Ord. A derive compares the variant and then the payload, which would make Probe(Docker) < Probe(Snmp) on declaration order alone. Ordering is only ever [Self::rank].

Externally tagged, which is serde's default and is left unstated for that reason. Thirty-three of these variants carry nothing, and a tag on a variant with no content is a key that distinguishes nothing — "Unspecified", not {"type":"Unspecified"}, in every row of fifteen columns. The two that do carry a [ClientProbe] keep it under their own name, {"Probe":"Snmp"}, which tells them apart from each other and from every bare name.

native_vlan_id?|

Native/untagged VLAN entity ID on this port (resolved from Q-BRIDGE dot1qPvid)

neighbor?null||

oper_status?null|

speed_bps?|

Interface speed from ifSpeed/ifHighSpeed in bits per second

vlan_ids?array<>|

Tagged VLAN entity IDs on this port (resolved from Q-BRIDGE dot1qVlanCurrentEgressPorts)

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/if-entries/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b",    "if_descr": "string",    "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3"  }'

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.13"
  },
  "success": true,
  "data": {
    "host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b",
    "if_descr": "string",
    "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
    "admin_status": null,
    "cdp_address": "192.168.1.1",
    "cdp_device_id": "string",
    "cdp_platform": "string",
    "cdp_port_id": "string",
    "fdb_macs": [
      "string"
    ],
    "if_alias": "string",
    "if_index": 0,
    "if_name": "string",
    "if_type": 0,
    "ip_address_id": "8023e300-4385-4d10-949a-4bc68dd26ff9",
    "lldp_chassis_id": null,
    "lldp_mgmt_addr": "192.168.1.1",
    "lldp_port_desc": "string",
    "lldp_port_id": null,
    "lldp_sys_desc": "string",
    "lldp_sys_name": "string",
    "mac_address": "a4:bb:6d:12:34:56",
    "mac_address_source": "Unspecified",
    "native_vlan_id": "7e2565a5-5e7c-42fe-bac1-1e159750d33c",
    "neighbor": null,
    "neighbor_seen_at": "2019-08-24T14:15:22Z",
    "oper_status": null,
    "speed_bps": 0,
    "vlan_ids": [
      "9d54a8f0-0127-444f-984f-03be3c3bb00d"
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "updated_at": "2019-08-24T14:15:22Z",
    "first_discovery_id": "6902465b-102c-46e4-8f8c-33ac44cf66e9",
    "last_discovery_id": "48da132e-8b2a-4a5e-9c95-ecca249347f8",
    "last_seen_at": "2019-08-24T14:15:22Z",
    "lineage_id": "29b62bee-90fd-477a-963b-7a89d5ffca9a",
    "valid_from": "2019-08-24T14:15:22Z",
    "valid_to": "2019-08-24T14:15:22Z"
  },
  "error": "string"
}

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.13"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.13"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`