Skip to main content

INKY API: open beta

New Features

The INKY API is in open beta

Read and manage your INKY estate from your own scripts and systems, with an API key you create in the console.

  • Stable: your teams and billable usage, on /v1.

  • Beta: allow and block lists, VIPs, console admins, reported mail triage, message search, and daily threat statistics, on /beta. Beta endpoints are fully documented but carry no stability promise, so don't build a production integration against them yet.

  • Create a key under Settings > API Keys. You need the Super Admin role on the team or organization the key is for. You choose each key's scope, its permissions per family, and an optional expiry.

  • The beta families need an active Kaseya relationship for your account. Read-only keys for teams and usage work for every account.

  • Documentation for your region, sign in with your INKY console account: docs.inkyphishfence.com (US) and docs.eu.inkyphishfence.com (EU).

  • Learn more: INKY External API (beta)

New