Created endpoint to read interface status and metrics, created unit test to test interface status endpoint, updated docs

Author: Jared Hendrickson

README.md

@@ -637,6 +637,10 @@ There is no limit to API calls at this time but is important to note that pfSens
 
   * [Read Gateway Status](#1-read-gateway-status)
 
+* [STATUS/INTERFACE](#statusinterface)
+
+  * [Read Interface Status](#1-read-interface-status)
+
 * [STATUS/LOG](#statuslog)
 
   * [Read Configuration History Status Log](#1-read-configuration-history-status-log)
@@ -3431,6 +3435,38 @@ URL: https://{{$hostname}}/api/v1/status/gateway
 
 
 
+## STATUS/INTERFACE
+
+
+
+### 1. Read Interface Status
+
+
+Read interface status and metrics.<br><br>
+
+_Requires at least one of the following privileges:_ [`page-all`, `page-status-interfaces`]
+
+
+***Endpoint:***
+
+```bash
+Method: GET
+Type: RAW
+URL: https://{{$hostname}}/api/v1/status/interface
+```
+
+
+
+***Body:***
+
+```js        
+{
+    
+}
+```
+
+
+
 ## STATUS/LOG
 
 

docs/documentation.json

@@ -4609,6 +4609,58 @@
 					"description": "API endpoints that read gateway statuses.",
 					"protocolProfileBehavior": {},
 					"_postman_isSubFolder": true
+				},
+				{
+					"name": "INTERFACE",
+					"item": [
+						{
+							"name": "Read Interface Status",
+							"protocolProfileBehavior": {
+								"disableBodyPruning": true
+							},
+							"request": {
+								"auth": {
+									"type": "bearer",
+									"bearer": [
+										{
+											"key": "token",
+											"value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJwZlNlbnNlIiwiZXhwIjoxNTk4MDcwMTAzLCJuYmYiOjE1OTgwNjE3MDMsImRhdGEiOiJhZG1pbiJ9.hgvNu96Bvsehcq6ygTa9LPB8eymiLnxYu4V6J8_h0-o",
+											"type": "string"
+										}
+									]
+								},
+								"method": "GET",
+								"header": [],
+								"body": {
+									"mode": "raw",
+									"raw": "{\n    \n}",
+									"options": {
+										"raw": {
+											"language": "json"
+										}
+									}
+								},
+								"url": {
+									"raw": "https://{{$hostname}}/api/v1/status/interface",
+									"protocol": "https",
+									"host": [
+										"{{$hostname}}"
+									],
+									"path": [
+										"api",
+										"v1",
+										"status",
+										"interface"
+									]
+								},
+								"description": "Read interface status and metrics.<br><br>\n\n_Requires at least one of the following privileges:_ [`page-all`, `page-status-interfaces`]"
+							},
+							"response": []
+						}
+					],
+					"description": "API endpoints that read interface statuses and metrics.",
+					"protocolProfileBehavior": {},
+					"_postman_isSubFolder": true
 				}
 			],
 			"description": "API endpoints that read and update system statuses.",

pfSense-pkg-API/files/etc/inc/api/endpoints/APIStatusInterface.inc

@@ -0,0 +1,26 @@
+<?php
+//   Copyright 2020 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIStatusInterface extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/status/interface";
+    }
+
+    protected function get() {
+        return (new APIStatusInterfaceRead())->call();
+    }
+}

pfSense-pkg-API/files/etc/inc/api/models/APIStatusInterfaceRead.inc

@@ -0,0 +1,42 @@
+<?php
+//   Copyright 2020 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
+require_once("api/framework/APIModel.inc");
+require_once("api/framework/APIResponse.inc");
+
+
+class APIStatusInterfaceRead extends APIModel {
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->privileges = ["page-all", "page-status-interfaces"];
+    }
+
+    public function action() {
+        return APIResponse\get(0, $this->__get_metrics());
+    }
+
+    private function __get_metrics() {
+        $if_descrs = get_configured_interface_with_descr(true);
+        $if_info = [];
+
+        foreach ($if_descrs as $if_descr => $if_name) {
+            $if = ["name" => $if_descr, "descr" => $if_name];
+            $if = $if + get_interface_info($if_descr);
+            $if_info[] = $if;
+        }
+        return $if_info;
+    }
+}