Skip to content

Examples➧

Search interface by parameters➧

Returning as array, may be several results. Parameters are not exclusive (the more parameters passed, the more matches there can be founded). Possible query parameters:

  • device_id - device id in wildcore
  • device_ip - device IP address
  • interface_name - name of interface. For example - epon0/1:1, or 1/3
  • interface_bind_key - a representative unique ID of an interface on a device. built based on interface name and hardware type
  • ont_ident - serial number or MAC-address of ONU
  • mac_address - client mac address, received from FDB
  • only_active_mac - flag (1|0) for searching by parameter mac_address. If setted 1 - will be returned only by active mac_address

Example of request: 

1
2
curl --location --request GET "http://${WILDCORE_SERVER}/api/v1/device-interface/search?device_id=${DEVICE_ID}&interface_name=${INTERFACE_NAME}" \
--header "X-Auth-Key: ${AUTH_KEY}"

Example of response: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
{
    "statusCode": 200,
    "meta": null,
    "data": [
        {
            "created_at": "2023-09-20 15:11:08",
            "updated_at": "2023-09-21 15:59:56",
            "device": {
                "ip": "10.1.0.6",
                "location": "Kyiv",
                "name": "sw-ak",
                "description": "",
                "model": {
                    "name": "D-Link DES-1228/ME",
                    "key": "dlink_des_1228_me",
                    "params": [],
                    "vendor": "D-Link",
                    "model": "DES-1228/ME",
                    "type": "SWITCH",
                    "controller": "\\WCC\\Switches\\Controllers\\SwitchesController",
                    "pollers": {
                        "system": 300,
                        "counters": 120,
                        "fdb_table": 600,
                        "sys_resources": 120,
                        "interfaces_list": 1800,
                        "interfaces_status": 120
                    },
                    "icon": "/upload/icons/des-1228-me.jpg",
                    "id": 24
                },
                "access": {
                    "params": {
                        "sw_core_connection": {
                            "snmp_port": 161,
                            "console_port": 22,
                            "snmp_repeats": 3,
                            "snmp_version": "2c",
                            "snmp_timeout_sec": 4,
                            "mikrotik_api_port": 55055,
                            "console_timeout_sec": 300,
                            "console_connection_type": "ssh"
                        }
                    },
                    "name": "",
                    "id": 6
                },
                "params": null,
                "updated_at": "2023-09-22 00:43:07",
                "created_at": "2023-09-20 15:10:49",
                "mac": "FC:75:16:00:00:00",
                "serial": "",
                "group": {
                    "created_at": "2023-05-10 12:17:00",
                    "name": "All",
                    "description": "",
                    "id": 5
                },
                "pollers": null,
                "coordinates": null,
                "enabled": true,
                "id": 495
            },
            "bind_key": "13",
            "name": "1/13",
            "type": "FE",
            "params": {
                "billing": {
                    "nodeny_plus": {
                        "id": 1161,
                        "link": "http://127.0.0.1/cgi-bin/stat.pl/cgi-bin/stat.pl?a=user&uid=1161",
                        "name": "",
                        "state": "on"
                    }
                }
            },
            "billing_link": "http://127.0.0.1/cgi-bin/stat.pl/cgi-bin/stat.pl?a=user&uid=1161",
            "ip": "",
            "agreement": "11619",
            "description": "",
            "status": "Up",
            "poll_enabled": true,
            "parent_bind_key": "",
            "coordinates": null,
            "comment": "",
            "id": 96252
        }
    ]
}

Device diagnostic➧

Returning diagnostic information from device

Example of request:➧

1
2
curl --location --request GET "http://${WILDCORE_SERVER}/api/v1/component/diagnostic/interface/${INTERFACE_ID}/diag?from=${FROM}" \
--header "X-Auth-Key: ${AUTH_KEY}"
  • FROM Variants:
    • device - Load from device
    • cache - Load from cache (If cache not exist or expired - will loading from device)
    • store - Load from cache
  • INTERFACE_ID - ID of interface, returned in interface.id

See detailed response objects here