Skip to content

Commit

Permalink
GitBook: [master] 3 pages modified
Browse files Browse the repository at this point in the history
  • Loading branch information
jordan-wright authored and gitbook-bot committed Oct 8, 2018
1 parent b8bbcc4 commit 298f619
Show file tree
Hide file tree
Showing 3 changed files with 285 additions and 111 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@

Gophish was built from the ground-up with a JSON API that makes it easy for developers and sysadmins to automate simulated phishing campaigns.

These docs describe how to use the [gophish](https://getgophish.com) API.
These docs describe how to use the [Gophish](https://getgophish.com) API. We hope you enjoy these docs, and please don't hesitate to [file an issue](https://github.com/gophish/gophish/issues/new) if you see anything missing.

{% hint style="info" %}
**Is Python your language of choice?** If so, we have a [fully-supported Python API client](https://docs.getgophish.com/python-api-client/) that makes working with the Gophish API a piece of cake!
{% endhint %}

## Use Cases

There are many reasons to use the Gophish API. The most common use case is to gather report information for a given campaign, so that you can build custom reports in software you're most familiar with, such as Excel or Numbers.

However, automating the creation of campaigns and campaign attributes such as templates, landing pages, and more provides the ability to create a fully automated phishing simulation program. This would allow campaigns to be run throughout the year automatically. This also allows the Gophish administrator to be included in the campaigns, since they wouldn't know exactly which day it would start!

## Authorization

Expand All @@ -24,7 +34,7 @@ GET /api/campaigns/?api_key=12345678901234567890123456789012

Many API endpoints return the JSON representation of the resources created or edited. However, if an invalid request is submitted, or some other error occurs, Gophish returns a JSON response in the following format:

```text
```javascript
{
"message" : string,
"success" : bool,
Expand Down
4 changes: 4 additions & 0 deletions settings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: These endpoints allow you to modify various Gophish settings.
---

# Settings

{% api-method method="post" host="https://localhost:3333" path="/api/reset" %}
Expand Down
Loading

0 comments on commit 298f619

Please sign in to comment.