weyne/wifipineapple-wiki
1
0
Fork 0
mirror of https://github.com/hak5darren/wifipineapple-wiki.git synced 2025-10-29 16:59:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update api.md

Browse Source
This commit is contained in:
Henry Pitcairn 2016-04-05 09:23:43 -04:00
parent dae6f8ecb7
commit 444064f2a7
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api.md
View File

@ -17,6 +17,8 @@ Many actions do not require additional parameters. For instance, `{"system": "no
``` ```
## Authentication ## Authentication
_(Please note that authentication not required when using the angular module api due to the fact that client side module components are loaded after the user authenticates their browser)_
There are a couple ways to authenticate with the pineapple. Requests sent via the web interface use a PHPSESSID cookie as well as an X-XSRF-TOKEN header. The pineapple will verify that the session is valid and logged in and that the XSRF token matches the one generated at the start of the session. If both of these conditions are met, the request is routed. An example of a request sent by chrome is as follows: There are a couple ways to authenticate with the pineapple. Requests sent via the web interface use a PHPSESSID cookie as well as an X-XSRF-TOKEN header. The pineapple will verify that the session is valid and logged in and that the XSRF token matches the one generated at the start of the session. If both of these conditions are met, the request is routed. An example of a request sent by chrome is as follows:
``` ```
POST /api/ HTTP/1.1 POST /api/ HTTP/1.1
@ -49,6 +51,13 @@ If the `apiToken` parameter is valid, the request will be route; otherwise an er
## Modules ## Modules
### Advanced ### Advanced
#### Description #### Description
The advanced module simplifies some more advanced processes like performing system upgrades and clearing system caches. FOr example, the following will clear the pineapple's caches:
```
{
"module": "Advanced",
"action": "dropCaches"
}
```
Action|Description|Parameters Action|Description|Parameters
------|-----------|---------- ------|-----------|----------
`getResources`|Returns a JSON array of disk and memory usage|_none_ `getResources`|Returns a JSON array of disk and memory usage|_none_
@ -103,6 +112,7 @@ Action|Description|Parameters
### PineAP ### PineAP
#### Description #### Description
### Recon ### Recon
#### Description #### Description
### Reporting ### Reporting