cURL
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,
"from_address": "<string>",
"ignore_cert_errors": true,
"is_secure": false
}
'import requests
url = "http://base.url.com/profiles"
payload = {
"name": "<string>",
"username": "<string>",
"password": "<string>",
"host": "<string>",
"port": 123,
"from_address": "<string>",
"ignore_cert_errors": True,
"is_secure": False
}
headers = {
"x-phishy-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-phishy-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
username: '<string>',
password: '<string>',
host: '<string>',
port: 123,
from_address: '<string>',
ignore_cert_errors: true,
is_secure: false
})
};
fetch('http://base.url.com/profiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "http://base.url.com/profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'username' => '<string>',
'password' => '<string>',
'host' => '<string>',
'port' => 123,
'from_address' => '<string>',
'ignore_cert_errors' => true,
'is_secure' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-phishy-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://base.url.com/profiles"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 123,\n \"from_address\": \"<string>\",\n \"ignore_cert_errors\": true,\n \"is_secure\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-phishy-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://base.url.com/profiles")
.header("x-phishy-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 123,\n \"from_address\": \"<string>\",\n \"ignore_cert_errors\": true,\n \"is_secure\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://base.url.com/profiles")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-phishy-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 123,\n \"from_address\": \"<string>\",\n \"ignore_cert_errors\": true,\n \"is_secure\": false\n}"
response = http.request(request)
puts response.read_body[
{
"name": "<string>",
"method": "<string>",
"fromAddress": "<string>",
"mailServer": "<string>",
"mailServerPort": 123,
"customPort": false,
"useSSLTLS": false,
"lastUpdatedBy": "<string>",
"lastModified": "<string>"
}
]{
"error": 123,
"message": "<string>"
}{
"error": 403,
"message": "You do not have permission to access this resource."
}SMTP Profiles
Create Profile
Creates a new profile
POST
/
profiles
cURL
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,
"from_address": "<string>",
"ignore_cert_errors": true,
"is_secure": false
}
'import requests
url = "http://base.url.com/profiles"
payload = {
"name": "<string>",
"username": "<string>",
"password": "<string>",
"host": "<string>",
"port": 123,
"from_address": "<string>",
"ignore_cert_errors": True,
"is_secure": False
}
headers = {
"x-phishy-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-phishy-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
username: '<string>',
password: '<string>',
host: '<string>',
port: 123,
from_address: '<string>',
ignore_cert_errors: true,
is_secure: false
})
};
fetch('http://base.url.com/profiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "http://base.url.com/profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'username' => '<string>',
'password' => '<string>',
'host' => '<string>',
'port' => 123,
'from_address' => '<string>',
'ignore_cert_errors' => true,
'is_secure' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-phishy-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://base.url.com/profiles"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 123,\n \"from_address\": \"<string>\",\n \"ignore_cert_errors\": true,\n \"is_secure\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-phishy-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://base.url.com/profiles")
.header("x-phishy-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 123,\n \"from_address\": \"<string>\",\n \"ignore_cert_errors\": true,\n \"is_secure\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://base.url.com/profiles")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-phishy-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"host\": \"<string>\",\n \"port\": 123,\n \"from_address\": \"<string>\",\n \"ignore_cert_errors\": true,\n \"is_secure\": false\n}"
response = http.request(request)
puts response.read_body[
{
"name": "<string>",
"method": "<string>",
"fromAddress": "<string>",
"mailServer": "<string>",
"mailServerPort": 123,
"customPort": false,
"useSSLTLS": false,
"lastUpdatedBy": "<string>",
"lastModified": "<string>"
}
]{
"error": 123,
"message": "<string>"
}{
"error": 403,
"message": "You do not have permission to access this resource."
}Body
application/json
Profile to add
Response
Profile created
