blob: b56db645656a146a21320e97929a20a93b9496a1 (
plain)
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
90
|
API-dok
=======
Work in progress.
General: All end-points that output time-based data accept the "now=<time>"
argument, where, <time> is YYYY-MM-DDThh:mm:ss. E.g:
GET /switch-state.pl?now=2015-04-02T15:00:00
There is no guarantee that the data is exact time-wise, thus each endpoint
should also output relevant time stamps.
Currently error handling sucks.
This document is in no way complete, but it's a start. It will be updated
as time permits and API's stabilize.
comment-add.pl
--------------
Methods: POST
-- Add a comment
comment-change.pl
-----------------
Methods: POST
Note that comments are never really deleted, but the state can be set to
deleted, making sure they are never shown.
comment.pl -- View comments
---------------------------
Methods: GET
Update frequency: on user input
ping.pl -- Being phased out
---------------------------
Methods: GET
Update frequency: every second or so.
Used to report switch latency and linknet latency.
The switch latency is being integrated into switch-state.pl and linknet
latency will similarly be moved.
port-state.pl -- Get per-port statistics
----------------------------------------
Methods: GET
Update frequency: Every few seconds, based on SNMP data.
Private.
Returns detailed per-port statistics. Being somewhat reorganized but will
remain highly relevant.
switches_add.pl -- Add a switch
-------------------------------
Methods: POST
Add switches, supports same format as tools/add_switches.txt.pl
Accepts an array of switches.
switches.pl
-----------
Methods: GET
Update frequency: Infrequent (on topology/config changes)
List all switches and map positions. Output is filtered for public users.
Used to draw switches on a map and provide static information.
switch-state.pl -- List state for switches
------------------------------------------
Methods: GET
Update frequency: Every second
Provides state for each switch, including total port speed, uplink port
speed, latency and temperature.
100% public.
|
