Miscellaneous Operations¶
Listing all the unique row names¶
Request¶
The request is a HTTP GET to the rows URL. See below for full summary:
URL |
/maddash/rows |
HTTP Method |
GET |
Response¶
Type: application/json
Field |
Type |
Required |
Description |
---|---|---|---|
rows |
JSON Array |
Yes |
List of row names |
row[n].id |
string |
Yes |
The name used by MaDDash when performing checks |
rows[n].name |
string |
Yes |
The display name used on the web interface |
Example¶
{
"rows":[
{
"id":"albq-owamp.es.net",
"name":"albq-owamp.es.net"
},
{
"id":"albq-pt1.es.net",
"name":"albq-pt1.es.net"
},
{
"id":"bois-owamp.es.net",
"name":"bois-owamp.es.net"
},
{
"id":"bois-pt1.es.net",
"name":"bois-pt1.es.net"
},
{
"id":"bost-owamp.es.net",
"name":"bost-owamp.es.net"
},
{
"id":"bost-pt1.es.net",
"name":"bost-pt1.es.net"
},
{
"id":"chic-owamp.es.net",
"name":"chic-owamp.es.net"
},
{
"id":"chic-pt1.es.net",
"name":"Chicago Tester"
}
]
}
Listing all the unique column names¶
Request¶
The request is a HTTP GET to the columns URL. See below for full summary:
URL |
/maddash/columns |
HTTP Method |
GET |
Response¶
Type: application/json
Field |
Type |
Required |
Description |
---|---|---|---|
columns |
JSON Array |
Yes |
List of column names |
columns[n].id |
string |
Yes |
The name used by MaDDash when performing checks |
columns[n].name |
string |
Yes |
The display name used on the web interface |
Example¶
{
"columns":[
{
"id":"albq-owamp.es.net",
"name":"albq-owamp.es.net"
},
{
"id":"albq-pt1.es.net",
"name":"albq-pt1.es.net"
},
{
"id":"bois-owamp.es.net",
"name":"bois-owamp.es.net"
},
{
"id":"bois-pt1.es.net",
"name":"bois-pt1.es.net"
},
{
"id":"bost-owamp.es.net",
"name":"bost-owamp.es.net"
},
{
"id":"bost-pt1.es.net",
"name":"bost-pt1.es.net"
},
{
"id":"chic-owamp.es.net",
"name":"chic-owamp.es.net"
},
{
"id":"chic-pt1.es.net",
"name":"Chicago Tester"
}
]
}
Listing all the unique check names¶
Request¶
The request is a HTTP GET to the checks URL. See below for full summary:
URL |
/maddash/checks |
HTTP Method |
GET |
Response¶
Type: application/json
Field |
Type |
Required |
Description |
---|---|---|---|
checks |
JSON Array |
Yes |
List of check names |
checks[n].name |
string |
Yes |
The name of the check |
Example¶
{
"checks":[
{
"name":"Loss"
},
{
"name":"Loss Reverse"
},
{
"name":"Throughput"
},
{
"name":"Throughput Reverse"
}
]
}