cristiancmoises
/
gophish
mirror of https://github.com/gophish/gophish
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Filling in some more API docs

pull/64/head
Jordan Wright 2015-12-25 22:42:59 -06:00
parent 594aef49a5
commit 69034c8e3f
2 changed files with 44 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
templates/docs.html
View File

File diff suppressed because one or more lines are too long

40
templates/gophish.apib
View File

@ -184,11 +184,6 @@ Get a campaign by its ID.
### Delete a Campaign [DELETE] ### Delete a Campaign [DELETE]
Delete a campaign by its ID. Delete a campaign by its ID.
::: warning
#### <i class="fa fa-warning"></i> Caution
If the value for `title` or `body` is `null` or `undefined`, then the corresponding value is not modified on the server. However, if you send an empty string instead then it will **permanently overwrite** the original value.
:::
+ Parameters + Parameters
+ id: `1` (required, number) - The Campaign ID + id: `1` (required, number) - The Campaign ID
@ -275,11 +270,6 @@ Get a template by its ID.
### Delete a Template [DELETE] ### Delete a Template [DELETE]
Delete a template by its ID. Delete a template by its ID.
::: warning
#### <i class="fa fa-warning"></i> Caution
If the value for `title` or `body` is `null` or `undefined`, then the corresponding value is not modified on the server. However, if you send an empty string instead then it will **permanently overwrite** the original value.
:::
+ Parameters + Parameters
+ id: `1` (required, number) - The Template ID + id: `1` (required, number) - The Template ID
@ -363,11 +353,6 @@ Get a group by its ID.
### Delete a Group [DELETE] ### Delete a Group [DELETE]
Delete a Group by its ID. Delete a Group by its ID.
::: warning
#### <i class="fa fa-warning"></i> Caution
If the value for `title` or `body` is `null` or `undefined`, then the corresponding value is not modified on the server. However, if you send an empty string instead then it will **permanently overwrite** the original value.
:::
+ Parameters + Parameters
+ id: `1` (required, number) - The Template ID + id: `1` (required, number) - The Template ID
@ -465,11 +450,6 @@ Modify a page by its ID.
### Delete a Page [DELETE] ### Delete a Page [DELETE]
Delete a page by its ID. Delete a page by its ID.
::: warning
#### <i class="fa fa-warning"></i> Caution
If the value for `title` or `body` is `null` or `undefined`, then the corresponding value is not modified on the server. However, if you send an empty string instead then it will **permanently overwrite** the original value.
:::
+ Parameters + Parameters
+ id: `1` (required, number) - The Page ID + id: `1` (required, number) - The Page ID
@ -501,16 +481,26 @@ This endpoint allows you to import a group from a CSV.
The fields expected in the CSV are as follows: The fields expected in the CSV are as follows:
+ Test + First Name
+ two + Last Name
+ Position
+ Email
+ Company
+ Request (application/json) + Request (multipart/form-data; boundary=----BOUNDARY)
+ Attributes (Template) + Body
------BOUNDARY
Content-Disposition: form-data; name="files[]"; filename="filename.csv"
Content-Type: application/vnd.ms-excel
[File Content]
------BOUNDARY
+ Response 201 (application/json) + Response 201 (application/json)
+ Attributes (Template) + Attributes (TargetList)
+ Response 400 (application/json) + Response 400 (application/json)