Skip to content

Commit c3f4a26

Browse files
Regenerated docs
1 parent 57fc7a6 commit c3f4a26

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To update pfSense API to the latest stable version, run the following command:
3434
pfsense-api update
3535
```
3636

37-
To revert to a previous version of pfSense API (e.g. v1.0.2), run the following command:
37+
To revert to a previous version of pfSense API (e.g. v1.1.7), run the following command:
3838
```
3939
pfsense-api revert v1.1.7
4040
```

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
```
3737
pfsense-api update
3838
```
39-
To revert to a previous version of pfSense API (e.g. v1.0.2), run the following command:
39+
To revert to a previous version of pfSense API (e.g. v1.1.7), run the following command:
4040
```
4141
pfsense-api revert v1.1.7
4242
```
@@ -414,7 +414,7 @@
414414
webConfigurator are required to make calls to the API endpoints<li>While not an enforced requirement, it is <strong>strongly</strong> recommended that you configure pfSense to use HTTPS instead of HTTP. This ensures that login credentials and/or API tokens remain secure in-transit</ul><h1>Installation</h1><p>To install pfSense API, simply run the following command from the pfSense shell:<br><pre><code>pkg add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.5-pkg-API.txz &amp;&amp; /etc/rc.restart_webgui
415415
</code></pre><p>To uninstall pfSense API, run the following command:<br><pre><code>pfsense-api delete
416416
</code></pre><p>To update pfSense API to the latest stable version, run the following command:<pre><code>pfsense-api update
417-
</code></pre><p>To revert to a previous version of pfSense API (e.g. v1.0.2), run the following command:<pre><code>pfsense-api revert v1.1.7
417+
</code></pre><p>To revert to a previous version of pfSense API (e.g. v1.1.7), run the following command:<pre><code>pfsense-api revert v1.1.7
418418
</code></pre><h3>Notes:</h3><ul><li>To install the 2.4 package, simply change the <code>2.5</code> in the install URL to <code>2.4</code>.<li>In order for pfSense to apply some required web server changes, it is required to restart the webConfigurator after installing the package<li>If you do not have shell access to pfSense, you can still install via the webConfigurator by navigating to
419419
&lsquo;Diagnostics &gt; Command Prompt&rsquo; and enter the commands there<li>When updating pfSense, <strong><em>you must reinstall pfSense API afterwards</em></strong>. Unfortunately, pfSense removes all existing packages and only re-installs packages found within pfSense&rsquo;s package repositories. Since pfSense API is not an official package in pfSense&rsquo;s repositories, it does not get reinstalled automatically.<li>The <code>pfsense-api</code> command line tool was introduced in v1.1.0. Refer to the corresponding documentation for earlier releases.</ul><h1>UI Settings &amp; Documentation</h1><p>After installation, you will be able to access the API user interface pages within the pfSense webConfigurator. These will be found under System &gt; API. The settings tab will allow you change various API settings such as enabled API interfaces, authentication modes, and more. Additionally, the documentation tab will give you access to an embedded documentation tool that makes it easy to view the full API documentation in context to your pfSense instance.<h3>Notes:</h3><ul><li>Users must hold the <code>page-all</code> or <code>page-system-api</code> privileges to access the API page within the webConfigurator</ul><h1>Authentication &amp; Authorization</h1><p>By default, pfSense API uses the same credentials as the webConfigurator. This behavior allows you to configure pfSense
420420
from the API out of the box, and user passwords may be changed from the API to immediately add additional security if
@@ -1983,7 +1983,7 @@
19831983
function IsJsonString(str){try{JSON.parse(str);}catch(e){return false;}
19841984
return true;}
19851985
String.prototype.replaceAll=function(replaceThis,withThis){var re=new RegExp(RegExp.quote(replaceThis),"g");return this.replace(re,withThis);};RegExp.quote=function(str){return str.replace(/([.?*+^$[\]\\(){}-])/g,"\\$1");};function syntaxHighlight(json){json=json.replace(/&/g,'&amp;').replace(/</g,'&lt;').replace(/>/g,'&gt;');return json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g,function(match){var cls='number';if(/^"/.test(match)){if(/:$/.test(match)){cls='key';}else{cls='string';}}else if(/true|false/.test(match)){cls='boolean';}else if(/null/.test(match)){cls='null';}
1986-
return '<span class="'+cls+'">'+match+'</span>';});}</script><br><br><footer class="navbar-default navbar-fixed-bottom"><div class=container-fluid><div class="span12 text-center"><span data-toggle=tooltip title="If the application help you, please feel free to give a star to the project in github. Your star inspire me to work more on open-source projects like this!">Made with <em class=love-color>&#9829;</em> by <a href=https://github.com/thedevsaddam target=_blank class=text-muted>thedevsaddam</a> | Generated at: 2021-03-17 15:46:10 by <a href=https://github.com/thedevsaddam/docgen target=_blank class=text-muted>docgen</a></span></div></div></footer>
1986+
return '<span class="'+cls+'">'+match+'</span>';});}</script><br><br><footer class="navbar-default navbar-fixed-bottom"><div class=container-fluid><div class="span12 text-center"><span data-toggle=tooltip title="If the application help you, please feel free to give a star to the project in github. Your star inspire me to work more on open-source projects like this!">Made with <em class=love-color>&#9829;</em> by <a href=https://github.com/thedevsaddam target=_blank class=text-muted>thedevsaddam</a> | Generated at: 2021-03-17 15:50:55 by <a href=https://github.com/thedevsaddam/docgen target=_blank class=text-muted>docgen</a></span></div></div></footer>
19871987
<script type="text/javascript">
19881988
$(document).ready(function() {
19891989
document.title = 'pfSense REST API Documentation';

0 commit comments

Comments
 (0)