Update an Interface
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Path Parameters
If entry ID
uuidRequest Body
application/json
SNMP ifAdminStatus: 1=up, 2=down, 3=testing
"Up" | "Down" | "Testing"The host this entity belongs to.
uuidSNMP ifDescr - interface description (e.g., GigabitEthernet0/1)
SNMP ifIndex - stable identifier within device
int32SNMP ifType - IANAifType integer (6=ethernet, 24=loopback, etc.)
int32The network this entity belongs to.
uuidSNMP ifOperStatus: 1=up, 2=down, 3=testing, 4=unknown, 5=dormant, 6=notPresent, 7=lowerLayerDown
"Up" | "Down" | "Testing" | "Unknown" | "Dormant" | "NotPresent" | "LowerLayerDown"Remote management IP from CDP (cdpCacheAddress). IPv4 or IPv6.
Remote device ID from CDP (typically hostname, locally unique)
Remote platform from CDP (e.g., "Cisco IOS")
Remote port ID from CDP
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.
SNMP ifAlias - user-configured description
SNMP ifName - short interface name (e.g., Gi1/0/1)
FK to IPAddress entity - this port's IP assignment (must be on same host). Old daemons send this as "interface_id".
uuidRemote management IP from LLDP neighbor (lldpRemManAddr). IPv4 or IPv6.
Remote port description from LLDP neighbor (lldpRemPortDesc)
Remote system description from LLDP neighbor (lldpRemSysDesc) - platform info
Remote system name from LLDP neighbor (lldpRemSysName)
MAC address from SNMP ifPhysAddress - immutable once set
^(?:[0-9A-Fa-f]{2}[:-]){5}[0-9A-Fa-f]{2}$Native/untagged VLAN entity ID on this port (resolved from Q-BRIDGE dot1qPvid)
uuidInterface speed from ifSpeed/ifHighSpeed in bits per second
int64Tagged VLAN entity IDs on this port (resolved from Q-BRIDGE dot1qVlanCurrentEgressPorts)
Response Body
application/json
application/json
application/json
curl -X PUT "https://app.scanopy.net/api/v1/if-entries/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "admin_status": "Up", "host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b", "if_descr": "string", "if_index": 0, "if_type": 0, "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3", "oper_status": "Up" }'{
"meta": {
"api_version": 1,
"server_version": "0.17.8"
},
"success": true,
"data": {
"admin_status": "Up",
"host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b",
"if_descr": "string",
"if_index": 0,
"if_type": 0,
"network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
"oper_status": "Up",
"cdp_address": "192.168.1.1",
"cdp_device_id": "string",
"cdp_platform": "string",
"cdp_port_id": "string",
"fdb_macs": [
"string"
],
"if_alias": "string",
"if_name": "string",
"ip_address_id": "8023e300-4385-4d10-949a-4bc68dd26ff9",
"lldp_chassis_id": {},
"lldp_mgmt_addr": "192.168.1.1",
"lldp_port_desc": "string",
"lldp_port_id": {},
"lldp_sys_desc": "string",
"lldp_sys_name": "string",
"mac_address": "a4:bb:6d:12:34:56",
"native_vlan_id": "7e2565a5-5e7c-42fe-bac1-1e159750d33c",
"neighbor": {},
"speed_bps": 0,
"vlan_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"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.8"
},
"success": true,
"code": "string",
"error": "string",
"params": {
"property1": null,
"property2": null
}
}{
"meta": {
"api_version": 1,
"server_version": "0.17.8"
},
"success": true,
"code": "string",
"error": "string",
"params": {
"property1": null,
"property2": null
}
}