API Documentation
- Introduction
- Authentication
- Authorization
- Simulations
Endpoints
- SMTP Profiles
- Targets
- Groups
- Pages
- Templates
- Attachments
- Campaigns
SMTP Profiles
Create Profile
Creates a new profile
POST
/
profiles
Copy
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
}'
Copy
[
{
"name": "<string>",
"method": "<string>",
"fromAddress": "<string>",
"mailServer": "<string>",
"mailServerPort": 123,
"customPort": false,
"useSSLTLS": false,
"lastUpdatedBy": "<string>",
"lastModified": "<string>"
}
]
Authorizations
Body
application/json
Profile to add
The body is of type object
.
Response
200
application/json
Profile created
The response is of type object[]
.
Copy
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
}'
Copy
[
{
"name": "<string>",
"method": "<string>",
"fromAddress": "<string>",
"mailServer": "<string>",
"mailServerPort": 123,
"customPort": false,
"useSSLTLS": false,
"lastUpdatedBy": "<string>",
"lastModified": "<string>"
}
]
Assistant
Responses are generated using AI and may contain mistakes.