Sending Profiles
A "Sending Profile" is the SMTP configuration that tells Gophish how to send emails.
Sending profiles support authentication and ignoring invalid SSL certificates.
Sending Profiles have the following structure:
Get Sending Profiles
GET
https://localhost/api/smtp/
Gets a list of the sending profiles created by the authenticated user.
Headers
Name | Type | Description |
---|---|---|
Authorization | string | A valid API key |
Get Sending Profile
GET
https://localhost:3333/api/smtp/:id
Returns a sending profile given an ID, returning a 404 error if no sending profile with the provided ID is found.
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | The sending profile ID to return |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | A valid API key |
Create Sending Profile
POST
https://localhost:3333/api/smtp
Creates a sending profile.
Headers
Name | Type | Description |
---|---|---|
Authorization | string | A valid API key |
Request Body
Name | Type | Description |
---|---|---|
Payload | object | The body of the request is a JSON representation of a sending profile. Refer to the introduction for the valid format of a sending profile. |
This method expects the sending profile to be provided in JSON format. You must provide a sending profile name
, the from_address
which emails are sent from, and the SMTP relay host
.
Sending Profiles support authentication by setting the username
and password
.
Additionally, many SMTP server deployments leverage self-signed certificates. To tell Gophish to ignore these invalid certificates, set the ignore_cert_errors
field to true
.
This method returns the JSON representation of the sending profile that was created.
Modify Sending Profile
PUT
https://localhost:3333/api/smtp/:id
Modifies an existing sending profile.
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | The sending profile ID to modify |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | A valid API key |
Request Body
Name | Type | Description |
---|---|---|
Payload | object | The body of the request is a JSON representation of a sending profile. Refer to the introduction for the valid format of a sending profile. |
This method expects the sending profile to be provided in JSON format. You must provide a full sending profile, not just the fields you want to update.
This method returns the JSON representation of the sending profile that was modified.
Delete Sending Profile
DELETE
https://localhost:3333/api/smtp/:id
Deletes a sending profile by ID.
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | The ID of the sending profile to delete |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | A valid API key |
Returns a 404 error if the specified sending profile isn't found.
This method returns a status message indicating the sending profile was deleted successfully.
Last updated