Developer docs

Documentation

Guides and API reference for running AntiBait analysis from the web app or from your own code.

Deploy to your organization

Install AntiBait on managed computers with the policies your browsers and mail clients already support, and pin its settings so users cannot change them.

At a glance

ClientID or URLHow to deploy
Chrome<chrome-extension-id>Force-install by ID with Chrome policy, Google Admin console or Intune.
Edge<edge-extension-id>Force-install by ID with Edge policy or Intune.
Firefoxantibait@antibait.ioForce-install the signed file from antibait.io with policies.json or Group Policy.
Thunderbirdantibait@antibait.ioForce-install the file from antibait.io with policies.json.
Outlookhttps://antibait.io/outlook-addin/manifest.xmlUpload the manifest URL in the Microsoft 365 admin center.

Deployment installs the client but signs no one in. Each person signs in with their own AntiBait account, and their checks count against that account's plan.

Chrome and Edge

Add AntiBait to the force-install list. The browser installs it from the store, keeps it updated, and users cannot remove it. On Windows, apply these registry keys or set ExtensionInstallForcelist with Group Policy.

Chrome · .reg
Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome\ExtensionInstallForcelist]
"1"="<chrome-extension-id>;https://clients2.google.com/service/update2/crx"
Edge · .reg
Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\ExtensionInstallForcelist]
"1"="<edge-extension-id>;https://edge.microsoft.com/extensionwebstorebase/v1/crx"

In Google Admin console, add the extension by ID under Apps and extensions and set it to Force install. In Intune, use the same ExtensionInstallForcelist setting from the Chrome or Edge administrative templates.

Pin settings

A setting set by policy overrides the user's choice and shows as locked in the extension. Chrome reads it from the extension's 3rdparty policy key:

Chrome · .reg
Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome\3rdparty\extensions\<chrome-extension-id>\policy]
"autoScan"="auto"
"showBanner"=dword:00000001
"linkWarnings"=dword:00000001

For Edge, set the same values under the Edge key below. In Google Admin console, enter them as JSON in the extension's Policy for extensions field.

Edge
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\3rdparty\extensions\<edge-extension-id>\policy

Firefox

Firefox installs the Mozilla-signed AntiBait file straight from antibait.io and keeps it updated from there. Put this policies.json in the distribution folder of the Firefox installation, or set the same values with Group Policy or a macOS configuration profile.

policies.json
{
  "policies": {
    "ExtensionSettings": {
      "antibait@antibait.io": {
        "installation_mode": "force_installed",
        "install_url": "https://antibait.io/downloads/firefox/latest.xpi"
      }
    },
    "3rdparty": {
      "Extensions": {
        "antibait@antibait.io": {
          "autoScan": "auto",
          "showBanner": true,
          "linkWarnings": true
        }
      }
    }
  }
}

latest.xpi always serves the current release. The 3rdparty block pins settings; leave it out to let users choose.

Thunderbird

Thunderbird supports the same ExtensionSettings policy. Put this policies.json in the distribution folder of the Thunderbird installation.

policies.json
{
  "policies": {
    "ExtensionSettings": {
      "antibait@antibait.io": {
        "installation_mode": "force_installed",
        "install_url": "https://antibait.io/downloads/thunderbird/latest.xpi"
      }
    }
  }
}

We document settings policies for Chrome, Edge and Firefox only. In Thunderbird, set them in the add-on's options.

Outlook

Deploy the Outlook add-in from the Microsoft 365 admin center. It works in Outlook on Windows, Mac and the web.

  1. 01

    Sign in to the Microsoft 365 admin center and open Settings, then Integrated apps.

  2. 02

    Choose Upload custom apps, select Office Add-in, and provide the link to the manifest file below.

  3. 03

    Choose the users or groups who should get the add-in, and finish the deployment.

  4. 04

    Ask people to open AntiBait from the message toolbar and sign in once.

Manifest URL
https://antibait.io/outlook-addin/manifest.xml

A deployed add-in can take several hours to appear in Outlook. Without an admin, a person can add it themselves: Get Add-ins, My add-ins, Add a custom add-in, Add from URL.

Settings you can pin

The same keys work in every policy above. Keys you leave out stay under the user's control.

KeyValuesDescription
apiBasehttps://…Origin of the AntiBait server to use, for example a self-hosted gateway. Users cannot change it when set.
autoScanauto | offauto checks every email automatically on plans that include it; off checks only when asked.
modelaccount | standard | enhanced | enterpriseDetection model. account uses the signed-in account's default.
rawCapturetrue | falseAnalyze the full message source instead of the page content.
showBannertrue | falseShow the verdict banner in the message.
linkWarningstrue | falseMark suspicious links in the message.

Verify the files

antibait.io publishes the SHA-256 of every file it serves at /downloads/index.json. Compare it with the file before you stage it for deployment.

Linux
curl -s https://antibait.io/downloads/index.json
sha256sum antibait-firefox-*.xpi
PowerShell
(Invoke-RestMethod https://antibait.io/downloads/index.json).firefox.sha256
Get-FileHash -Algorithm SHA256 .\antibait-firefox-*.xpi

Need help integrating the API? The support team replies within 24 hours on business days.