mirror of https://github.com/opnsense/docs
API: core api's 20.1 update
Ad Schellevis
4 years ago
parent
c0d7a022b2
commit
6d3dbaedfc
@ -1,42 +1,53 @@
|
||||
|
||||
CaptivePortal
|
||||
Captiveportal
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. csv-table:: Service
|
||||
.. csv-table:: Resources (AccessController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","captiveportal","access","logoff","$zoneid=0"
|
||||
"``POST``","captiveportal","access","logon","$zoneid=0"
|
||||
"``POST``","captiveportal","access","status","$zoneid=0"
|
||||
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","captiveportal","service","reconfigure",""
|
||||
"``POST``","captiveportal","service","delTemplate","$uuid"
|
||||
"``GET``","captiveportal","service","getTemplate","$fileid=null"
|
||||
"``POST``","captiveportal","service","reconfigure",""
|
||||
"``POST``","captiveportal","service","saveTemplate",""
|
||||
"``GET``","captiveportal","service","searchTemplates",""
|
||||
|
||||
.. csv-table:: Resources
|
||||
.. csv-table:: Resources (SessionController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","captiveportal","service","addtemplate",""
|
||||
"``POST``","captiveportal","service","deltemplate","$uuid"
|
||||
"``GET``","captiveportal","service","gettemplate","$fileid"
|
||||
"``GET``","captiveportal","service","searchtemplates",""
|
||||
"``GET``","captiveportal","service","searchtemplates","$uuid"
|
||||
"``POST``","captiveportal","service","settemplate","$uuid"
|
||||
"``POST``","captiveportal","settings","addzone",""
|
||||
"``POST``","captiveportal","settings","delzone","$uuid"
|
||||
"``GET``","captiveportal","settings","getzone","$uuid"
|
||||
"``GET``","captiveportal","settings","searchzones",""
|
||||
"``POST``","captiveportal","settings","setzone","$uuid"
|
||||
"``POST``","captiveportal","settings","togglezone","$uuid/$enabled"
|
||||
|
||||
.. csv-table:: Other
|
||||
"``POST``","captiveportal","session","connect","$zoneid=0"
|
||||
"``POST``","captiveportal","session","disconnect","$zoneid=0"
|
||||
"``GET``","captiveportal","session","list","$zoneid=0"
|
||||
"``GET``","captiveportal","session","zones",""
|
||||
|
||||
.. csv-table:: Resources (SettingsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"","captiveportal","service","saveTemplate",""
|
||||
"","captiveportal","session","disconnect",""
|
||||
"","captiveportal","session","list",""
|
||||
"","captiveportal","session","zones",""
|
||||
"","captiveportal","voucher","dropExpiredVouchers",""
|
||||
"","captiveportal","voucher","dropVoucherGroup",""
|
||||
"","captiveportal","voucher","expireVoucher",""
|
||||
"","captiveportal","voucher","generateVouchers",""
|
||||
"","captiveportal","voucher","listProviders",""
|
||||
"","captiveportal","voucher","listVoucherGroups",""
|
||||
"","captiveportal","voucher","listVouchers",""
|
||||
"``POST``","captiveportal","settings","addZone",""
|
||||
"``POST``","captiveportal","settings","delZone","$uuid"
|
||||
"``GET``","captiveportal","settings","getZone","$uuid=null"
|
||||
"``*``","captiveportal","settings","searchZones",""
|
||||
"``POST``","captiveportal","settings","setZone","$uuid"
|
||||
"``POST``","captiveportal","settings","toggleZone","$uuid,$enabled=null"
|
||||
|
||||
.. csv-table:: Resources (VoucherController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","captiveportal","voucher","dropExpiredVouchers","$provider,$group"
|
||||
"``POST``","captiveportal","voucher","dropVoucherGroup","$provider,$group"
|
||||
"``POST``","captiveportal","voucher","expireVoucher","$provider"
|
||||
"``POST``","captiveportal","voucher","generateVouchers","$provider"
|
||||
"``GET``","captiveportal","voucher","listProviders",""
|
||||
"``GET``","captiveportal","voucher","listVoucherGroups","$provider"
|
||||
"``GET``","captiveportal","voucher","listVouchers","$provider,$group"
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
Core
|
||||
~~~~
|
||||
|
||||
.. csv-table:: Resources (MenuController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","core","menu","search",""
|
||||
"``GET``","core","menu","tree",""
|
||||
|
||||
.. csv-table:: Resources (SystemController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","core","system","halt",""
|
||||
"``GET``","core","system","reboot",""
|
||||
|
||||
@ -1,19 +1,20 @@
|
||||
Cron
|
||||
~~~~
|
||||
|
||||
.. csv-table:: Service
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","cron","service","reconfigure",""
|
||||
"``POST``","cron","service","reconfigure",""
|
||||
|
||||
.. csv-table:: Resources
|
||||
.. csv-table:: Resources (SettingsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","cron","settings","addjob",""
|
||||
"``POST``","cron","settings","deljob","$uuid"
|
||||
"``GET``","cron","settings","getjob","$uuid"
|
||||
"``GET``","cron","settings","searchjobs",""
|
||||
"``POST``","cron","settings","setjob","$uuid"
|
||||
"``POST``","cron","settings","togglejob","$uuid/$enabled"
|
||||
"``POST``","cron","settings","addJob",""
|
||||
"``POST``","cron","settings","delJob","$uuid"
|
||||
"``GET``","cron","settings","getJob","$uuid=null"
|
||||
"``*``","cron","settings","searchJobs",""
|
||||
"``POST``","cron","settings","setJob","$uuid"
|
||||
"``POST``","cron","settings","toggleJob","$uuid,$enabled=null"
|
||||
|
||||
|
||||
@ -1,37 +1,59 @@
|
||||
|
||||
Diagnostics
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. csv-table:: Settings
|
||||
.. csv-table:: Resources (ActivityController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","diagnostics","activity","getActivity",""
|
||||
|
||||
.. csv-table:: Resources (DnsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","diagnostics","dns","reverse_lookup",""
|
||||
|
||||
.. csv-table:: Resources (FirewallController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","diagnostics","firewall","log",""
|
||||
|
||||
.. csv-table:: Resources (InterfaceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","diagnostics","interface","delRoute",""
|
||||
"``POST``","diagnostics","interface","flushArp",""
|
||||
"``GET``","diagnostics","interface","getArp",""
|
||||
"``GET``","diagnostics","interface","getInterfaceNames",""
|
||||
"``GET``","diagnostics","interface","getNdp",""
|
||||
"``GET``","diagnostics","interface","getRoutes",""
|
||||
|
||||
.. csv-table:: Resources (NetflowController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","diagnostics","netflow","getconfig",""
|
||||
"``GET``","diagnostics","netflow","setconfig",""
|
||||
"``POST``","diagnostics","netflow","setconfig",""
|
||||
"``GET``","diagnostics","netflow","cacheStats",""
|
||||
"``GET``","diagnostics","netflow","getconfig",""
|
||||
"``GET``","diagnostics","netflow","isEnabled",""
|
||||
"``POST``","diagnostics","netflow","reconfigure",""
|
||||
"``GET``","diagnostics","netflow","setconfig",""
|
||||
"``GET``","diagnostics","netflow","status",""
|
||||
|
||||
.. csv-table:: Diagnostics
|
||||
.. csv-table:: Resources (NetworkinsightController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"","diagnostics","activity","getActivity",""
|
||||
"","diagnostics","dns","reverse",""
|
||||
"","diagnostics","firewall","log",""
|
||||
"","diagnostics","interface","flushArp",""
|
||||
"","diagnostics","interface","getArp",""
|
||||
"","diagnostics","interface","getInterfaceNames",""
|
||||
"","diagnostics","interface","getNdp",""
|
||||
"","diagnostics","interface","getRoutes",""
|
||||
"","diagnostics","netflow","cacheStats",""
|
||||
"","diagnostics","netflow","isEnabled",""
|
||||
"","diagnostics","netflow","reconfigure",""
|
||||
"","diagnostics","networkinsight","export",""
|
||||
"","diagnostics","networkinsight","getInterfaces",""
|
||||
"","diagnostics","networkinsight","getMetadata",""
|
||||
"","diagnostics","networkinsight","getProtocols",""
|
||||
"","diagnostics","networkinsight","getServices",""
|
||||
"","diagnostics","networkinsight","timeserie","FlowInterfaceTotals/bps/"
|
||||
"","diagnostics","networkinsight","top","FlowDstPortTotals/"
|
||||
"","diagnostics","systemhealth","getInterfaces",""
|
||||
"","diagnostics","systemhealth","getRRDlist",""
|
||||
"","diagnostics","systemhealth","getSystemHealth",""
|
||||
"``GET``","diagnostics","networkinsight","getInterfaces",""
|
||||
"``GET``","diagnostics","networkinsight","getMetadata",""
|
||||
"``GET``","diagnostics","networkinsight","getProtocols",""
|
||||
"``GET``","diagnostics","networkinsight","getServices",""
|
||||
|
||||
.. csv-table:: Resources (SystemhealthController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","diagnostics","systemhealth","getInterfaces",""
|
||||
"``GET``","diagnostics","systemhealth","getRRDlist",""
|
||||
|
||||
|
||||
@ -0,0 +1,32 @@
|
||||
Firewall
|
||||
~~~~~~~~
|
||||
|
||||
.. csv-table:: Resources (AliasController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","firewall","alias","addItem",""
|
||||
"``POST``","firewall","alias","delItem","$uuid"
|
||||
"``GET``","firewall","alias","export",""
|
||||
"``GET``","firewall","alias","getAliasUUID","$name"
|
||||
"``GET``","firewall","alias","getGeoIP",""
|
||||
"``GET``","firewall","alias","getItem","$uuid=null"
|
||||
"``POST``","firewall","alias","import",""
|
||||
"``GET``","firewall","alias","listCountries",""
|
||||
"``POST``","firewall","alias","reconfigure",""
|
||||
"``*``","firewall","alias","searchItem",""
|
||||
"``POST``","firewall","alias","setItem","$uuid"
|
||||
"``POST``","firewall","alias","toggleItem","$uuid,$enabled=null"
|
||||
|
||||
.. csv-table:: Resources (AliasUtilController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","firewall","alias_util","add","$alias"
|
||||
"``GET``","firewall","alias_util","aliases",""
|
||||
"``POST``","firewall","alias_util","delete","$alias"
|
||||
"``POST``","firewall","alias_util","find_references",""
|
||||
"``POST``","firewall","alias_util","flush","$alias"
|
||||
"``GET``","firewall","alias_util","list","$alias"
|
||||
"``GET``","firewall","alias_util","update_bogons",""
|
||||
|
||||
@ -0,0 +1,25 @@
|
||||
Interfaces
|
||||
~~~~~~~~~~
|
||||
|
||||
.. csv-table:: Resources (LoopbackSettingsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","interfaces","loopback_settings","addItem",""
|
||||
"``POST``","interfaces","loopback_settings","delItem","$uuid"
|
||||
"``GET``","interfaces","loopback_settings","getItem","$uuid=null"
|
||||
"``POST``","interfaces","loopback_settings","reconfigure",""
|
||||
"``*``","interfaces","loopback_settings","searchItem",""
|
||||
"``POST``","interfaces","loopback_settings","setItem","$uuid"
|
||||
|
||||
.. csv-table:: Resources (VxlanSettingsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","interfaces","vxlan_settings","addItem",""
|
||||
"``POST``","interfaces","vxlan_settings","delItem","$uuid"
|
||||
"``GET``","interfaces","vxlan_settings","getItem","$uuid=null"
|
||||
"``POST``","interfaces","vxlan_settings","reconfigure",""
|
||||
"``*``","interfaces","vxlan_settings","searchItem",""
|
||||
"``POST``","interfaces","vxlan_settings","setItem","$uuid"
|
||||
|
||||
@ -0,0 +1,20 @@
|
||||
Ipsec
|
||||
~~~~~
|
||||
|
||||
.. csv-table:: Resources (KeyPairsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","ipsec","key_pairs","addItem",""
|
||||
"``POST``","ipsec","key_pairs","delItem","$uuid"
|
||||
"``GET``","ipsec","key_pairs","getItem","$uuid=null"
|
||||
"``*``","ipsec","key_pairs","searchItem",""
|
||||
"``POST``","ipsec","key_pairs","setItem","$uuid=null"
|
||||
|
||||
.. csv-table:: Resources (LegacySubsystemController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","ipsec","legacy_subsystem","applyConfig",""
|
||||
"``GET``","ipsec","legacy_subsystem","status",""
|
||||
|
||||
@ -0,0 +1,40 @@
|
||||
Monit
|
||||
~~~~~
|
||||
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","monit","service","configtest",""
|
||||
"``POST``","monit","service","reconfigure",""
|
||||
|
||||
.. csv-table:: Resources (SettingsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","monit","settings","addAlert",""
|
||||
"``POST``","monit","settings","addService",""
|
||||
"``POST``","monit","settings","addTest",""
|
||||
"``POST``","monit","settings","delAlert","$uuid"
|
||||
"``POST``","monit","settings","delService","$uuid"
|
||||
"``POST``","monit","settings","delTest","$uuid"
|
||||
"``GET``","monit","settings","dirty",""
|
||||
"``GET``","monit","settings","getAlert","$uuid=null"
|
||||
"``GET``","monit","settings","getGeneral",""
|
||||
"``GET``","monit","settings","getService","$uuid=null"
|
||||
"``GET``","monit","settings","getTest","$uuid=null"
|
||||
"``*``","monit","settings","searchAlert",""
|
||||
"``*``","monit","settings","searchService",""
|
||||
"``*``","monit","settings","searchTest",""
|
||||
"``POST``","monit","settings","setAlert","$uuid"
|
||||
"``POST``","monit","settings","setService","$uuid"
|
||||
"``POST``","monit","settings","setTest","$uuid"
|
||||
"``POST``","monit","settings","toggleAlert","$uuid,$enabled=null"
|
||||
"``POST``","monit","settings","toggleService","$uuid,$enabled=null"
|
||||
|
||||
.. csv-table:: Resources (StatusController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","monit","status","get","$format='xml'"
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
Openvpn
|
||||
~~~~~~~
|
||||
|
||||
.. csv-table:: Resources (ExportController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","openvpn","export","accounts","$vpnid"
|
||||
"``POST``","openvpn","export","download","$vpnid,$certref=null"
|
||||
"``GET``","openvpn","export","providers",""
|
||||
"``POST``","openvpn","export","storePresets","$vpnid"
|
||||
"``GET``","openvpn","export","templates",""
|
||||
"``POST``","openvpn","export","validatePresets","$vpnid"
|
||||
|
||||
@ -0,0 +1,20 @@
|
||||
Syslog
|
||||
~~~~~~
|
||||
|
||||
.. csv-table:: Service (ServiceController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","syslog","service","stats",""
|
||||
|
||||
.. csv-table:: Resources (SettingsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``POST``","syslog","settings","addDestination",""
|
||||
"``POST``","syslog","settings","delDestination","$uuid"
|
||||
"``GET``","syslog","settings","getDestination","$uuid=null"
|
||||
"``*``","syslog","settings","searchDestinations",""
|
||||
"``POST``","syslog","settings","setDestination","$uuid"
|
||||
"``POST``","syslog","settings","toggleDestination","$uuid,$enabled=null"
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
Unbound
|
||||
~~~~~~~
|
||||
|
||||
.. csv-table:: Resources (DiagnosticsController.php)
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
|
||||
"``GET``","unbound","diagnostics","dumpcache",""
|
||||
"``GET``","unbound","diagnostics","dumpinfra",""
|
||||
"``GET``","unbound","diagnostics","listinsecure",""
|
||||
"``GET``","unbound","diagnostics","listlocaldata",""
|
||||
"``GET``","unbound","diagnostics","listlocalzones",""
|
||||
"``GET``","unbound","diagnostics","stats",""
|
||||
|
||||
Loading…
Reference in New Issue