| Both sides previous revisionPrevious revision | |
| packet:bpq-api [2024/10/08 08:26] – m7gmt | packet:bpq-api [2025/01/02 19:13] (current) – [Route Roadmap] m0lte |
|---|
| Detailed info about the routes that exist and those yet to come. | Detailed info about the routes that exist and those yet to come. |
| |
| ^ Route ^ Method ^ Description ^ Authentication required? ^ Implemented? ^ Example response ^ | ^ Route ^ Method ^ Description ^ Authentication required? ^ Implemented? ^ Example response ^ |
| | /api/request_token | GET | Get a token that you will need for authenticated routes | no | yes | `{ "access_token":"TJFCQDBRVSSHGPWIXFHAJFFKSMZISADL", "expires_in":3600, "scope":"create" }` | | | /api/request_token | GET | Get a token that you will need for authenticated routes | no | yes | `{ "access_token":"TJFCQDBRVSSHGPWIXFHAJFFKSMZISADL", "expires_in":3600, "scope":"create" }` | |
| | /api/ports | GET | A list of the available ports | no | yes | `{ "ports": [ {"ID":"Telnet Server (internal only)", "Driver":"TELNET", "Number":1,"State":"Open"}, {"ID":"AX/IP/UDP", "Driver":"BPQAXIP", "Number":2,"State":"Open"}, {"ID":"2m FM 144.950 MHz 1.2k", "Driver":"ASYNC", "Number":3,"State":"Open"} ] }` | | | /api/ports | GET | A list of the available ports | no | yes | `{ "ports": [ {"ID":"Telnet Server (internal only)", "Driver":"TELNET", "Number":1,"State":"Open"}, {"ID":"AX/IP/UDP", "Driver":"BPQAXIP", "Number":2,"State":"Open"}, {"ID":"2m FM 144.950 MHz 1.2k", "Driver":"ASYNC", "Number":3,"State":"Open"} ] }` | |
| | /api/routes | GET | A list of available routes | no | no | | | | /api/routes | GET | A list of available routes | no | no | | |
| | /api/stats | GET | Version, uptime stats, etc | no | no | | | | /api/stats | GET | Version, uptime stats, etc | no | no | | |
| | | /api/v1/mail/msgs | GET | Gets a list of messages | yes | yes but incomplete responses | | |
| ===== The one Tom built ===== | ===== The one Tom built ===== |
| |
