Skip to content

Commit 115dacc

Browse files
- Converted error codes and messages to a PHP array found apiresp.inc. This allows functions to pull the error message from a centralized location using it's unique error code
- Add function and API call to read the error code library as JSON. This allows third-party scripts/software to directly integrate with the APIs error reporting. - Changed API configuration location from /pfsense/config/installedpackages/package/id to /pfsense/config/installedpackages/package/id/conf for better readability - Added API call to read API configuration - Update pkg-plist and Makefile
1 parent a315916 commit 115dacc

14 files changed

Lines changed: 1593 additions & 988 deletions

File tree

pfSense-pkg-API/Makefile

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ do-install:
2525
${STAGEDIR}/etc/inc
2626
${INSTALL_DATA} ${FILESDIR}/etc/inc/apicalls.inc \
2727
${STAGEDIR}/etc/inc
28+
${INSTALL_DATA} ${FILESDIR}/etc/inc/apiresp.inc \
29+
${STAGEDIR}/etc/inc
2830

2931
# INSTALL OUR PFSENSE PKG
3032
${MKDIR} ${STAGEDIR}${PREFIX}/pkg
@@ -105,6 +107,14 @@ do-install:
105107
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/system/version
106108
${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/system/version/index.php \
107109
${STAGEDIR}${PREFIX}/www/api/v1/system/version
110+
# API base
111+
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/system/api
112+
${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/system/api/index.php \
113+
${STAGEDIR}${PREFIX}/www/api/v1/system/api
114+
# API errors base
115+
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/system/api/errors
116+
${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/system/api/errors/index.php \
117+
${STAGEDIR}${PREFIX}/www/api/v1/system/api/errors
108118
# ARP base
109119
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/system/arp
110120
${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/system/arp/index.php \
@@ -187,6 +197,18 @@ do-install:
187197

188198
# FIREWALL API ENPOINTS
189199
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/firewall
200+
# STATES base
201+
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/firewall/states
202+
${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/firewall/states/index.php \
203+
${STAGEDIR}${PREFIX}/www/api/v1/firewall/states
204+
# STATES size
205+
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/firewall/states/size
206+
${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/firewall/states/size/index.php \
207+
${STAGEDIR}${PREFIX}/www/api/v1/firewall/states/size
208+
# STATES size modify
209+
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/firewall/states/size/modify
210+
${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/firewall/states/size/modify/index.php \
211+
${STAGEDIR}${PREFIX}/www/api/v1/firewall/states/size/modify
190212
# NAT base
191213
${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/firewall/nat
192214
${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/firewall/nat/index.php \

0 commit comments

Comments
 (0)