Added read services enpoint /services/index.php to return a list of available services and their current status

Author: jaredhendrickson13

pfSense-pkg-API/Makefile

@@ -185,7 +185,10 @@ do-install:
 		${STAGEDIR}${PREFIX}/www/api/v1/firewall/rules/delete
 
 	# SERVICE API ENDPOINTS----------------------------------------
+	# Services base
 	${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/services
+	${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/services/index.php \
+		${STAGEDIR}${PREFIX}/www/api/v1/services
 	# Unbound base
 	${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/services/unbound
 	${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/services/unbound/index.php \

pfSense-pkg-API/files/usr/local/www/api/v1/services/index.php

@@ -0,0 +1,60 @@
+<?php
+
+// IMPORTS--------------------------------------------------------------------------------------------------------------
+require_once("config.inc");
+require_once("auth.inc");
+require_once("functions.inc");
+require_once("api.inc");
+
+// HEADERS--------------------------------------------------------------------------------------------------------------
+api_runtime_allowed();    // Check that our configuration allows this API call to run first
+header('Content-Type: application/json');
+header("Referer: no-referrer");
+
+// VARIABLES------------------------------------------------------------------------------------------------------------
+global $config, $api_resp, $client_params;
+$read_only_action = true;    // Set whether this action requires read only access
+$req_privs = array("page-all", "page-status-services");    // Array of privs allowed
+$http_method = $_SERVER['REQUEST_METHOD'];    // Save our HTTP method
+
+// RUN TIME-------------------------------------------------------------------------------------------------------------
+// Check that client is authenticated and authorized
+if (api_authorized($req_privs, $read_only_action)) {
+    // Check that our HTTP method is POST (READ)
+    if ($http_method === 'GET') {
+        if (isset($client_params['name'])) {
+            $name = $client_params['name'];
+        }
+        $service_list = get_services();    // Stop our service
+        // Loop through our service list and add our service status
+        foreach ($service_list as $key => $srvc) {
+            $s_status = get_service_status($srvc);
+            // Check if service is started
+            if ($s_status === true) {
+                $service_list[$key]["status"] = "running";
+            } elseif ($s_status === false) {
+                $service_list[$key]["status"] = "stopped";
+            } else {
+                $service_list[$key]["status"] = "unknown";
+            }
+            // Check if user requested only one service, if so remove unmatched services
+            if (isset($name) and $name !== $srvc["name"]) {
+                unset($service_list[$key]);
+            }
+        }
+        // Print our JSON response
+        $api_resp = array("status" => "ok", "code" => 200, "return" => 0, "message" => "", "data" => $service_list);
+        http_response_code(200);
+        echo json_encode($api_resp) . PHP_EOL;
+        die();
+    } else {
+        $api_resp = array("status" => "bad request", "code" => 400, "return" => 2, "message" => "invalid http method");
+        http_response_code(400);
+        echo json_encode($api_resp) . PHP_EOL;
+        die();
+    }
+} else {
+    http_response_code(401);
+    echo json_encode($api_resp) . PHP_EOL;
+    die();
+}

pfSense-pkg-API/pkg-plist

@@ -87,6 +87,7 @@
 /usr/local/www/api/v1/firewall/rules/add/index.php
 /usr/local/www/api/v1/firewall/rules/delete/index.php
 
+@dir /usr/local/www/api/v1/services
 @dir /usr/local/www/api/v1/services/unbound
 @dir /usr/local/www/api/v1/services/unbound/add
 @dir /usr/local/www/api/v1/services/unbound/delete
@@ -97,6 +98,7 @@
 @dir /usr/local/www/api/v1/services/unbound/add/hosts
 @dir /usr/local/www/api/v1/services/unbound/delete/hosts
 @dir /usr/local/www/api/v1/services/unbound/modify/hosts
+/usr/local/www/api/v1/services/index.php
 /usr/local/www/api/v1/services/unbound/index.php
 /usr/local/www/api/v1/services/unbound/start/index.php
 /usr/local/www/api/v1/services/unbound/stop/index.php