Gophish

Gophish is a powerful, open-source phishing framework that makes it easy to test your organization's exposure to phishing. For Free.

Deception & Breach Simulation · Gophish

Configuration parameters

  • url — Server URL (e.g. https://fqdnofyourserver:3333) (required)
  • apikey — API Key (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (32)

  • gophish-complete-campaign

    Marks a campaign as complete.

  • gophish-create-campaign

    Creates and launches a new campaign.

  • gophish-create-group

    Creates a new group.

  • gophish-create-landing-page

    Creates a landing page.

  • gophish-create-sending-profile

    Creates a sending profile.

  • gophish-create-template

    Creates a new template from the provided data

  • gophish-create-user

    Creates a new user

  • gophish-delete-campaign

    Deletes a campaign by ID

  • gophish-delete-group

    Deletes a group

  • gophish-delete-landing-page

    Deletes a landing page.

  • gophish-delete-sending-profile

    Deletes a sending profile by ID.

  • gophish-delete-template

    Deletes a template by ID.

  • gophish-delete-user

    Deletes a user, as well as every object (landing page, template, etc.) and campaign they've created.

  • gophish-get-all-campaigns

    Returns a list of campaigns.

  • gophish-get-all-groups

    Returns a list of groups.

  • gophish-get-all-groups-summary

    Returns a summary of each group.

  • gophish-get-all-landing-pages

    Returns a list of landing pages.

  • gophish-get-all-sending-profiles

    Gets a list of the sending profiles created by the authenticated user.

  • gophish-get-all-templates

    Returns a list of templates.

  • gophish-get-campaign-details

    Returns a campaign given an ID.

  • gophish-get-campaign-results

    Gets the results for a campaign.

  • gophish-get-campaign-summary

    Returns summary information about a campaign.

  • gophish-get-group

    Returns a group with the given ID.

  • gophish-get-group-summary

    It may be the case that you just want the number of members in a group, not necessarily the full member details. This API endpoint returns a summary for a group.

  • gophish-get-landing-page

    Gets a landing page info

  • gophish-get-sending-profile

    Returns a sending profile given an ID, returning a 404 error if no sending profile with the provided ID is found.

  • gophish-get-template

    Returns a template with the provided ID.Returns a 404: Not Found error if the specified template doesn't exist.

  • gophish-get-user

    Get single user details from gophish

  • gophish-get-users

    Gets all users from gophish

  • gophish-import-site-as-landing-page

    Fetches a URL to be later imported as a landing page

  • gophish-import-template

    This method doesn't fully import the email as a template. Instead, it parses the email, returning a response that can be used with the "Create Template" endpoint.

  • gophish-modify-user

    Modifies a user account. This can be used to change the role, reset the password, or change the username.