INKY API (beta)

Overview

The INKY API is a REST API for reading and managing your INKY estate from your own scripts and systems: your teams and billable usage, allow and block lists, VIPs, console admins, reported mail, the analysis record of the mail INKY processed, and daily threat counts.

It is a server-to-server API. Every request carries an API key in an X-API-Key header, and responses are JSON. Call it from your own backend, not from a browser.

The documentation

The full guides and the API reference are on the INKY developer portal. Use the portal for the region your INKY account is in:

• US: docs.inkyphishfence.com

• EU: docs.eu.inkyphishfence.com

Sign in with your INKY console account. Any console role can read the portal: Viewer, Analyst, Policy Admin or Super Admin.

Good places to start:

• Overview: what the API covers and how stability works.

• Creating an API key: the console flow, permissions, rotation and expiry.

• Quickstart: your first call, paging, and generating a client.

• Beta stability and changes: what may change on the beta, and the changelog of every change.

EU readers can open the same pages on docs.eu.inkyphishfence.com.

What you can do

The path of each endpoint tells you what it promises. /v1 is stable. /beta is the beta.

• Teams (/v1): list the teams your key can see and read a team's details.

• Usage (/v1): billable mailbox counts across your estate, current and historical.

• Allow list and block list (/beta): read and manage sender rules, one at a time or in bulk.

• VIPs (/beta): read and manage the protected names INKY uses to catch display-name spoofing.

• Admins (/beta): read and manage who holds console roles across your estate.

• Reported mail (/beta): review user-reported mail, remediate it, and apply allow or block rules from a report.

• Messages (/beta, read-only): search the messages INKY processed, with their verdicts and full analysis.

• Statistics (/beta, read-only): one team's daily counts by verdict, reason and result category.

The API only answers requests. It doesn't push events to you, so an integration polls on an interval. If you need to hear about events as they happen, use Custom SIEM Feed (Admin Center > Integrations) or Custom Reporting Email Notifications (Admin Center > User Reporting).

Getting a key

Create keys in the INKY console under Admin Center > API Keys. You need the Super Admin role on the team or organization the key is for. Each key has:

• A scope: the team or organization selected in the team switcher when you create it. An organization key reaches every team beneath it.

• Permissions: chosen per family and per operation. The default key is read-only for teams and usage.

• An optional expiry.

The console shows the key once, when you create it. Copy it into your secret manager straight away. INKY can't show it to you again; a lost key is replaced by rotating it.

Use the API host for your region: https://api.inkyphishfence.com (US) or https://api.eu.inkyphishfence.com (EU). A key from one region doesn't work in the other.

Who can use the beta families

Any account can create a read-only key for teams and usage. The management families (allow list, block list, VIPs, admins, reported mail, messages and statistics) need an active Kaseya relationship for the account. Without one, the key permission picker grays those families out.

If Admin Center > API Keys is missing from your navigation, or the page says API Keys management is not available for your account, contact your INKY representative.

Using a coding agent

Coding agents can't sign in to the portal, so the guides are also published as plain text at /llms.txt on each portal host. The API's own OpenAPI document is at /v1/openapi.json on each API host and needs no key. Point your agent or a client generator at those.

Feedback

The beta is here to find out what doesn't work for you. Report a defect, a missing capability, or a family that doesn't fit how you work to your INKY representative. Include the endpoint you called, and the error.code and message from the response if you got one.