SURFmailfilter biedt een API alles wat in de userinterface mogelijk is ook via een API te kunnen doen. Te denken valt aan het aanmaken van domeinen en users.
Om toegang te verkrijgen is een API key nodig. Deze is te verkrijgen door door in te loggen en rechtsboven op je gebruikersnaam te klikken. Kies vervolgens voor "profile".
Hier in een API key aan te maken, waarmee je toegang kunt krijgen. Deze key kun je gebruiken in je scripts.
Uitgebreide documentatie is bij onze leverancier Halon te vinden. Zie hiervoor: https://docs.halon.io/msui/api/ .
Het API endpoint van SURFmailfilter is te vinden op https://api.surfmailfilter.nl . Wil je bijvoorbeeld al je domeinen opvragen met curl, en je API key is 1234, dan doe je hetvolgende:
curl -H 'Content-Type: application/json' -H 'X-API-Key: 1234' https://api.surfmailfilter.nl/xhr/domain