Before you start
Mesh’s REST API is available to every partner since Mesh release 1.7.11. You manage API keys in the Partner Hub under Settings > API Keys (Mesh’s API Keys help). Mesh 365 and Mesh Unified customers need Mesh’s Azure permissions in place for release from Junk and for remediation. A customer with an “Azure permissions incomplete” banner in the Partner Hub cannot have those actions run, by Neo or by you.1. Create the API key
1
Open API Keys
Sign in to the Partner Hub (hub-us.emailsecurity.app, or hub-eu.emailsecurity.app in Europe) and open Settings > API Keys.
2
Name it and pick the team member
Name the key Neo. Select a team member with the Partner role: the key acts as that team member, so a partner admin reaches every customer.
3
Choose the permissions
Give the key the permissions for the jobs your agents do:
4
Set the expiry date and copy the key
Set an expiry date you will remember, submit, and copy the key. Mesh shows it only once.
2. Add the key in Neo
1
Open Integrations
In the Neo Dashboard, open Integrations and find the Mesh card, under Email Security.
2
Save the key
Choose the region you sign in to, paste the API key and click Save settings. Neo reads your first customer with it before saving, so a wrong key or region is rejected straight away.
3. Turn Mesh on per agent
Open the agent, go to its Tools & Settings tab, click Email Security, and expand the Mesh block. Pick one of its Presets, or set each area yourself:
Mesh publishes its full API reference inside the Partner Hub only. If a Mesh call starts to fail after a Mesh update, tell Neo support.
See Mesh API for what the agent can read and change.
