Skip to content
Snippets Groups Projects
Commit 4b1dc849 authored by Erik Reid's avatar Erik Reid
Browse files

added doc for poller/interfaces/hostname

parent 63d03dff
No related branches found
No related tags found
No related merge requests found
......@@ -310,5 +310,46 @@ Any non-empty responses are JSON formatted messages.
"type": "object"
}
```
### Test Commit
\ No newline at end of file
* /poller/interfaces/*`hostname`*
The response will be the list of active interfaces on the
router `hostname`.
Each element of the returned list contains information necessary
for setting up snmp throughput counter polling.
The response will be formatted according to the following schema:
```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"circuit": {
"type": "object",
"properties": {
"type": {"type": "string"},
"id": {"type": "integer"}
},
"required": ["type", "id"],
"additionalProperties": False
}
},
"type": "array",
"items": {
"type": "object",
"properties": {
"circuits": {
"type": "array",
"items": {"$ref": "#/definitions/circuit"}
},
"description": {"type": "string"},
"name": {"type": "string"},
"snmp-index": {"type": "integer"}
},
"required": ["circuits", "description", "name", "snmp-index"],
"additionalProperties": False
}
}
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment