Commit 694b2aaa authored by PidgeyL's avatar PidgeyL
Browse files

API Documentation update

parent b42343f7
Loading
Loading
Loading
Loading
+3 −2
Original line number Diff line number Diff line
@@ -98,10 +98,11 @@
                <p>
                  Some API calls require authentication. Authentication is done in one of two ways:
                  <ul>
                    <li>Username - Password (Not recommended)</li>
                    <li>Username - Token </li>
                    <li>basic &lt;username&gt;:&lt;password&gt; (Not recommended)</li>
                    <li>token &lt;username&gt;:&lt;token&gt; </li>
                  </ul>
                  Authentication is done by adding the following header to the HTTP request: <br />
                  <pre>Authorization: basic user:password123</pre> or 
                  <pre>Authorization: token user:679c2955085b46e48155b84f4c878844</pre> <br />
                  <b>PLEASE NOTE: Neither the password nor the token are obfuscated, so it is <u>strongly</u> advised to use HTTPS</b>
                </p>
+1 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@
{% set id       = "blacklist_add"            %}
{% set title    = "/api/admin/blacklist/add" %}
{% set method   = "PUT"                      %}
{% set headers  = [('Content-Type', "This field is required to be set to:",  "application/x-www-form-urlencoded")]%}
{% set formdata = [('cpe', "CPE code in cpe2.2 or cpe2.3 format", "cpe:2.3:o:gnu:gcc#Comment"),
                   ('type', "CPE type", "cpe, targetsoftware or targethardware")] %}

+1 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@
{% set id       = "blacklist_remove"            %}
{% set title    = "/api/admin/blacklist/remove" %}
{% set method   = "PUT"                         %}
{% set headers  = [('Content-Type', "This field is required to be set to:",  "application/x-www-form-urlencoded")]%}
{% set formdata = [('cpe', "CPE code in cpe2.2 or cpe2.3 format", "cpe:2.3:o:gnu:gcc#Comment")] %}

{% block desc %}
+1 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@
{% set id       = "whitelist_add"            %}
{% set title    = "/api/admin/whitelist/add" %}
{% set method   = "PUT"                      %}
{% set headers  = [('Content-Type', "This field is required to be set to:", "application/x-www-form-urlencoded")]%}
{% set formdata = [('cpe', "CPE code in cpe2.2 or cpe2.3 format", "cpe:2.3:o:gnu:gcc#Comment"),
                   ('type', "CPE type", "cpe, targetsoftware or targethardware")] %}

+1 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@
{% set id       = "whitelist_remove"            %}
{% set title    = "/api/admin/whitelist/remove" %}
{% set method   = "PUT"                         %}
{% set headers  = [('Content-Type', "This field is required to be set to:",  "application/x-www-form-urlencoded")]%}
{% set formdata = [('cpe', "CPE code in cpe2.2 or cpe2.3 format", "cpe:2.3:o:gnu:gcc#Comment")] %}

{% block desc %}
Loading