Antispam API Documentation

Adding or Viewing Domains

Methods: GET/POST

You can add a new domain using the following command

curl -d '{"domain":"abc2.com","destination":"abc2.com","port":"25"}' -u [email protected]:password -i -X POST -H "Content-Type: application/json" https://hq.oikik.io/api/domain
Arguments:
Flag Argument Note
-d domain The domain you want to add
destination The mailbox address where the mail will be relayed to
port The destination server's TCP port
-u email:password The registered email and password for authentication

You can add view the list of your current domains using the following command

curl -u [email protected]:password -i -X GET https://hq.oikik.io/api/domain
Arguments:
Flag Argument Note
-u email:password The registered email and password for authentication

Adding or Viewing Recipient Addresses

Methods: GET/POST

You can add a new recipient address using the following command

curl -d '{"address":"abc.com"}' -u [email protected]:123456 -i -X POST -H "Content-Type: application/json" https://hq.oikik.io/api/recipient
Arguments:
Flag Argument Note
-d address The recipient address you want to add
-u email:password The registered email and password for authentication

You can add view the list of your recipient addresses using the following command

curl -u [email protected]:password -i -X GET https://hq.oikik.io/api/recipient
Arguments:
Flag Argument Note
-u email:password The registered email and password for authentication

Adding or Viewing Whitelist

Methods: GET/POST

You can add a new address to whitelist using the following command

curl -d '{"sender":"[email protected]","receiver":"[email protected]"}' -u [email protected]:password -i -X POST -H "Content-Type: application/json" https://hq.oikik.io/api/whitelist
Arguments:
Flag Argument Note
-d sender The email address of the sender
receiver the email address of the recipient (must be in your domain)
-u email:password The registered email and password for authentication

You can add view the list of your whitelisted addresses using the following command

curl -u [email protected]:password -i -X GET https://hq.oikik.io/api/whitelist
Arguments:
Flag Argument Note
-u email:password The registered email and password for authentication

Deleting Domains, Recipient Addresses or Whitelisted Addresses

Method: DELETE

You can delete a domain using the following command

curl -d '{"domain":"[email protected]"}' -u [email protected]:password -i -X DELETE -H "Content-Type: application/json" https://hq.oikik.io/api/delete/domain
Arguments:
Flag Argument Note
-d domain The domain you want to delete
-u email:password The registered email and password for authentication

You can delete a recipient address using the following command

curl -d '{"address":"[email protected]"}' -u [email protected]:123456 -i -X DELETE -H "Content-Type: application/json" https://hq.oikik.io/api/delete/recipient
Arguments:
Flag Argument Note
-d address The recipient address you want to delete
-u email:password The registered email and password for authentication

You can delete an address/domain from whitelist using the following command

curl -d '{"sender":"[email protected]", "receiver":"[email protected]"}' -u [email protected]:123456 -i -X DELETE -H "Content-Type: application/json" https://hq.oikik.io/api/delete/whitelist
Arguments:
Flag Argument Note
-d sender The email address of the sender
receiver the email address of the recipient (must be in your domain)
-u email:password The registered email and password for authentication