hak5
/
hak5-docs
mirror of https://github.com/hak5/hak5-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GitBook: [master] 3 pages modified

master
Marc 2021-08-26 17:02:50 +00:00 committed by gitbook-bot
parent 6bde11a178
commit 11a7e98f81
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
3 changed files with 0 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
SUMMARY.md
View File

@ -23,7 +23,6 @@
## Developer Documentation
* [REST API](developer-documentation/rest-api/README.md)
* [Untitled](developer-documentation/rest-api/untitled.md)
* [REST Errors](developer-documentation/rest-api/rest-errors.md)
* [API Authentication](developer-documentation/rest-api/api-authentication.md)
* [Notifications](developer-documentation/rest-api/notifications.md)

92
developer-documentation/rest-api/README.md
View File

@ -4,95 +4,3 @@ description: WiFi Pineapple Mark VII REST API
# REST API
{% api-method method="delete" host="172.16.42.1:1471" path="/api/recon/scan/:id" %}
{% api-method-summary %}
Delete Recon Scan
{% endapi-method-summary %}
{% api-method-description %}
{% endapi-method-description %}
{% api-method-spec %}
{% api-method-request %}
{% api-method-path-parameters %}
{% api-method-parameter name="" type="string" required=false %}
{% endapi-method-parameter %}
{% endapi-method-path-parameters %}
{% endapi-method-request %}
{% api-method-response %}
{% api-method-response-example httpCode=200 %}
{% api-method-response-example-description %}
{% endapi-method-response-example-description %}
```
```
{% endapi-method-response-example %}
{% endapi-method-response %}
{% endapi-method-spec %}
{% endapi-method %}
{% api-method method="get" host="172.16.42.1:1471" path="/api/recon/scan/:id" %}
{% api-method-summary %}
Get Recon Scan
{% endapi-method-summary %}
{% api-method-description %}
This endpoint returns a Recon scan.
{% endapi-method-description %}
{% api-method-spec %}
{% api-method-request %}
{% api-method-path-parameters %}
{% api-method-parameter name="id" type="string" %}
ID of the cake to get, for free of course.
{% endapi-method-parameter %}
{% endapi-method-path-parameters %}
{% api-method-headers %}
{% api-method-parameter name="Authentication" type="string" required=true %}
Authentication token to track down who is emptying our stocks.
{% endapi-method-parameter %}
{% endapi-method-headers %}
{% api-method-query-parameters %}
{% api-method-parameter name="recipe" type="string" %}
The API will do its best to find a cake matching the provided recipe.
{% endapi-method-parameter %}
{% api-method-parameter name="gluten" type="boolean" %}
Whether the cake should be gluten-free or not.
{% endapi-method-parameter %}
{% endapi-method-query-parameters %}
{% endapi-method-request %}
{% api-method-response %}
{% api-method-response-example httpCode=200 %}
{% api-method-response-example-description %}
Cake successfully retrieved.
{% endapi-method-response-example-description %}
```
{ "name": "Cake's name", "recipe": "Cake's recipe name", "cake": "Binary cake"}
```
{% endapi-method-response-example %}
{% api-method-response-example httpCode=404 %}
{% api-method-response-example-description %}
Could not find a cake matching this query.
{% endapi-method-response-example-description %}
```
{ "message": "Ain't no cake like that."}
```
{% endapi-method-response-example %}
{% endapi-method-response %}
{% endapi-method-spec %}
{% endapi-method %}

2
developer-documentation/rest-api/untitled.md
View File

@ -1,2 +0,0 @@
# Untitled