POST
/
profiles
curl --request POST \
  --url http://base.url.com/profiles \
  --header 'Content-Type: application/json' \
  --header 'x-phishy-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "username": "<string>",
  "password": "<string>",
  "host": "<string>",
  "port": 123,
  "interface_type": "SMTP",
  "from_address": "<string>",
  "ignore_cert_errors": true,
  "is_secure": false
}'
[
  {
    "name": "<string>",
    "method": "<string>",
    "fromAddress": "<string>",
    "mailServer": "<string>",
    "mailServerPort": 123,
    "customPort": false,
    "useSSLTLS": false,
    "lastUpdatedBy": "<string>",
    "lastModified": "<string>"
  }
]

Authorizations

​
x-phishy-api-key
string
header
required

Body

application/json
Profile to add
​
name
string
required

A descriptive name for the SMTP configuration

​
username
string
required

Username for SMTP authentication

​
password
string
required

Password for SMTP authentication

​
host
string
required

SMTP server host address

​
port
integer
required

SMTP server port

​
interface_type
enum<string>
required

Type of the email sending interface

Available options:
SMTP,
API
​
from_address
string
required

The email address to use in the 'From' field

​
ignore_cert_errors
boolean
default:true
required

Specifies if SSL/TLS certificate errors should be ignored

​
is_secure
boolean
default:false
required

Indicates if the connection should be secured (SSL/TLS)

Response

200
application/json
Profile created
​
name
string
required

Name of the user

​
method
string
required

Method used for the profile

​
fromAddress
string
required

Originating address of the profile

​
mailServer
string
required

Mail server address used for the profile

​
mailServerPort
integer
required

Port used by the mail server

​
customPort
boolean
default:false
required

Indicates if a custom port is used

​
useSSLTLS
boolean
default:false
required

Indicates if SSL/TLS is used for the connection

​
lastUpdatedBy
string

User who last updated the profile

​
lastModified
string

Date and time when the profile was last modified