Documentation
¶
Overview ¶
Package main - Arkgate REST API.
Core Routes:
/
Method: GET
Headers: NONE
Return: Basic page for health check only
Return-Status: 200
/api/v1/login
Method: GET
Headers: Authorization Basic
Return: JSON object with JWT
Return-Status: 200
/api/v1/modules
Method: GET
Headers: Authorization Bearer (policies)
Return: JSON {"modules": [...]} - every module name actually
mounted in this run (core + enabled optional), sorted.
See ActiveModuleNames in moduleregistry.go.
Return-Status: 200
Directories
¶
| Path | Synopsis |
|---|---|
|
Package database - Database session engine
|
Package database - Database session engine |
|
modules
|
|
|
acme/model
Package acme - Acme specific functions
|
Package acme - Acme specific functions |
|
acme/routes
Package acmeroutes - Arkgate API acme module
|
Package acmeroutes - Arkgate API acme module |
|
billportal/model
Package billportal - BillPortal specific functions
|
Package billportal - BillPortal specific functions |
|
billportal/routes
Package billportalroutes - Arkgate API billportal module
|
Package billportalroutes - Arkgate API billportal module |
|
captiveportal/model
Package captiveportal - CaptivePortal specific functions
|
Package captiveportal - CaptivePortal specific functions |
|
captiveportal/routes
Package captiveportalroutes - Arkgate API captiveportal module
|
Package captiveportalroutes - Arkgate API captiveportal module |
|
changes/model
Package changes - change specific functions
|
Package changes - change specific functions |
|
changes/routes
Package Changeroutes - Arkgate API Change module
|
Package Changeroutes - Arkgate API Change module |
|
collections/model
Package collections - Collection specific functions
|
Package collections - Collection specific functions |
|
collections/routes
Package collectionroutes - Arkgate API Collection module
|
Package collectionroutes - Arkgate API Collection module |
|
dhcps/model
Package dhcps - Dhcp specific functions
|
Package dhcps - Dhcp specific functions |
|
dhcps/routes
Package dhcproutes - Arkgate API Dhcp module
|
Package dhcproutes - Arkgate API Dhcp module |
|
dhcpserver/model
Package dhcpserver - DhcpServer specific functions
|
Package dhcpserver - DhcpServer specific functions |
|
dhcpserver/routes
Package dhcpserverroutes - Arkgate API dhcpserver module
|
Package dhcpserverroutes - Arkgate API dhcpserver module |
|
diagnostics/routes
Package diagnosticsroutes - Arkgate API diagnostics module
|
Package diagnosticsroutes - Arkgate API diagnostics module |
|
fdmonitor/routes
Package fdmonitorroutes - Arkgate API fdmonitor module
|
Package fdmonitorroutes - Arkgate API fdmonitor module |
|
firewall/model
Package Fws - User specific functions
|
Package Fws - User specific functions |
|
firewall/routes
Package Fwroutes - Arkgate API Fw module
|
Package Fwroutes - Arkgate API Fw module |
|
gatewaymonitor/model
Package gatewaymonitor - GatewayMonitor specific functions
|
Package gatewaymonitor - GatewayMonitor specific functions |
|
gatewaymonitor/routes
Package gatewaymonitorroutes - Arkgate API gatewaymonitor module
|
Package gatewaymonitorroutes - Arkgate API gatewaymonitor module |
|
groups/model
Package groups - Group specific functions
|
Package groups - Group specific functions |
|
groups/routes
Package grouproutes - Arkgate API Group module
|
Package grouproutes - Arkgate API Group module |
|
netblocks/model
Package netblocksmodel - speedtest netblocks
|
Package netblocksmodel - speedtest netblocks |
|
netblocks/routes
Package netblocksroutes - Arkgate API speedtest netblocks module
|
Package netblocksroutes - Arkgate API speedtest netblocks module |
|
payments/model
Package payments - Payment specific functions
|
Package payments - Payment specific functions |
|
payments/routes
Package paymentroutes - Arkgate API Payment module
|
Package paymentroutes - Arkgate API Payment module |
|
pfconfig/model
Package pfconfigs - Pfconfig specific functions
|
Package pfconfigs - Pfconfig specific functions |
|
pfconfig/routes
Package pfconfigroutes - Arkgate API Pfconfig module
|
Package pfconfigroutes - Arkgate API Pfconfig module |
|
pfifaces/model
Package pfifaces - Pfiface specific functions
|
Package pfifaces - Pfiface specific functions |
|
pfifaces/routes
Package pfifaceroutes - Arkgate API Pfiface module
|
Package pfifaceroutes - Arkgate API Pfiface module |
|
pflows/model
Package pflows - Pflow specific functions
|
Package pflows - Pflow specific functions |
|
pflows/routes
Package pflowroutes - Arkgate API Pflow module
|
Package pflowroutes - Arkgate API Pflow module |
|
plans/model
Package plans - Plan specific functions
|
Package plans - Plan specific functions |
|
plans/routes
Package planroutes - Arkgate API Plan module
|
Package planroutes - Arkgate API Plan module |
|
policies/model
Package policys - Policy specific functions
|
Package policys - Policy specific functions |
|
policies/routes
Package policyroutes - Arkgate API Policy module
|
Package policyroutes - Arkgate API Policy module |
|
power/model
Package powermodel - restart or shut down the gateway
|
Package powermodel - restart or shut down the gateway |
|
power/routes
Package powerroutes - Arkgate API power module
|
Package powerroutes - Arkgate API power module |
|
pppoes/model
Package pppoes - pppoe specific functions
|
Package pppoes - pppoe specific functions |
|
pppoes/routes
Package pppoeroutes - Arkgate API pppoe module
|
Package pppoeroutes - Arkgate API pppoe module |
|
runtimes/model
Package runtimes - Runtime specific functions
|
Package runtimes - Runtime specific functions |
|
runtimes/routes
Package runtimeroutes - Arkgate API Runtime module
|
Package runtimeroutes - Arkgate API Runtime module |
|
rworkers/model
Package rworkers - Rworker specific functions
|
Package rworkers - Rworker specific functions |
|
rworkers/routes
Package rworkerroutes - Arkgate API Rworker module
|
Package rworkerroutes - Arkgate API Rworker module |
|
snmpserver/model
Package snmpserver - SnmpServer specific functions
|
Package snmpserver - SnmpServer specific functions |
|
snmpserver/routes
Package snmpserverroutes - Arkgate API snmpserver module
|
Package snmpserverroutes - Arkgate API snmpserver module |
|
staticroutes/model
Package staticroutes - StaticRoute specific functions
|
Package staticroutes - StaticRoute specific functions |
|
staticroutes/routes
Package staticroutesroutes - Arkgate API staticroutes module
|
Package staticroutesroutes - Arkgate API staticroutes module |
|
subs/model
Package subs - User specific functions
|
Package subs - User specific functions |
|
subs/routes
Package subroutes - Arkgate API Sub module
|
Package subroutes - Arkgate API Sub module |
|
tunnels/model
Package tunnels - Tunnel specific functions
|
Package tunnels - Tunnel specific functions |
|
tunnels/routes
Package tunnelroutes - Arkgate API Tunnel module
|
Package tunnelroutes - Arkgate API Tunnel module |
|
unbounddns/model
Package unbounddns - UnboundDns specific functions
|
Package unbounddns - UnboundDns specific functions |
|
unbounddns/routes
Package unbounddnsroutes - Arkgate API unbounddns module
|
Package unbounddnsroutes - Arkgate API unbounddns module |
|
updates/model
Package updatesmodel - software update settings and OS patch checks
|
Package updatesmodel - software update settings and OS patch checks |
|
updates/routes
Package updatesroutes - Arkgate API software update module
|
Package updatesroutes - Arkgate API software update module |
|
users/model
Package users - User specific functions
|
Package users - User specific functions |
|
users/routes
Package userroutes - Arkgate API User module
|
Package userroutes - Arkgate API User module |
|
vlans/model
Package Vlans - User specific functions
|
Package Vlans - User specific functions |
|
vlans/routes
Package vlanroutes - Arkgate API vlan module
|
Package vlanroutes - Arkgate API vlan module |
|
vouchers/model
Package vouchers - Voucher specific functions
|
Package vouchers - Voucher specific functions |
|
vouchers/routes
Package voucherroutes - Arkgate API Voucher module
|
Package voucherroutes - Arkgate API Voucher module |
|
Package utils - Utilities to support SANG API
|
Package utils - Utilities to support SANG API |
|
validate
Package validate provides input-validation helpers used by module models' Bind() implementations.
|
Package validate provides input-validation helpers used by module models' Bind() implementations. |
Click to show internal directories.
Click to hide internal directories.