Intelligence API

When integrating Netify into a user interface (UI), it is often necessary to present the end user with intelligence and cybersecurity information. Integrator API endpoints are available to fetch Netify's intelligence list, categories, and release logs as JSON objects.

The API returns JSON objects containing IDs, tags, human-friendly labels, categories, and version information. Cache catalog responses and refresh periodically to reduce API calls and improve UI responsiveness.

Quick Links - Integration APIs

Endpoint Summary

The following endpoints provide information on the intelligence supported by the Netify Agent:

Data	Description
Intelligence Catalog	The list of supported intelligence drivers.
Intelligence Categories	The list of categories used by intelligence.
Intelligence Release Logs	The log of intelligence additions and deletions.

Authentication

To access these endpoints, an API key must be passed in the x-api-key parameter in the request headers. Please contact us for details about acquiring an API key.

Response Codes and Format

Standard HTTP response codes are sent by the API, along with the following status attributes (if available):

status_code: a status code number
status_message: a human-readable status message
status_fields: an array of validation errors (if any)

Response Payload - Status Information

{
   "status_code": 0,
   "status_message": "Success.",
   "data": ...
}

Additionally, the API sends standard HTTP response codes.

Code	Response	Description
200	OK	Request was successful
400	Bad Request	The client request was invalid
401	Unauthorized	The API key or credentials were invalid
403	Forbidden	The API key or credentials were valid, but access was not permitted
404	Not Found	The resource was not found
405	Method Not Allowed	The method is not supported by the API
409	Conflict	Resource already exists
422	Validation Error	Parameters sent in the request were invalid
429	Too Many Requests	Too many requests were sent to the server
500	Server Error	Server-side error (rare)

Intelligence Catalog Endpoint

GET

https://agents.netify.ai/api/v2/integrator/intelligence/catalog

Returns the list of all intelligence drivers - past and present - supported by the Netify Agent.

Parameters

version

string

If the Netify agent version is passed as a parameter to the endpoint, the catalog results will only include the intelligence supported in the specified version. You can specify the full version (e.g. 5.0.62), or a major version number (e.g. 5.0 for all version 5.0.x releases).

Intelligence Attributes

id

integer

The ID number associated with the intelligence driver.

tag

string

The tag associated with the intelligence driver.

label

string

The name an end user would typically use to identify the intelligence driver.

description

string

A one or two-sentence description of the intelligence driver.

supported

string

The Netify plugin version where the intelligence driver was introduced.

deprecated

string

The Netify plugin version where the intelligence driver was deprecated.

Intelligence Object - JSON Example

{
    "id": 5,
    "tag": "tls_cipher_score",
    "label": "TLS Cipher Score",
    "description": "TLS connection...",
    "category": {
        "tag": "encryption_audit",
        "label": "Encryption Audit"
    },
    "supported": "5.1.25",
    "deprecated": ""
}

Intelligence Categories Endpoint

GET

https://agents.netify.ai/api/v2/integrator/intelligence/categories

Returns the list of intelligence categories.

Intelligence Category Attributes

id

integer

The intelligence category ID.

tag

string

The intelligence category tag.

label

string

The intelligence category label.

Intelligence Category - JSON Example

{
    "id": 4,
    "tag": "encrypted_dns_detection",
    "label": "Encrypted DNS Detection"
},
{
    "id": 6,
    "tag": "encryption_audit",
    "label": "Encryption Audit"
},
...

Intelligence Release Log Endpoint

GET

https://agents.netify.ai/api/v2/integrator/intelligence/releaselog

Returns the intelligence release log with additions and deletions in release order.

Intelligence Release Log Attributes

intelligence

object

The intelligence object associated with the release log entry.

type

string

The type of change (e.g., added, updated, deleted).

version

string

The Netify plugin release version.

Intelligence Release Log - JSON Example

{
  "intelligence": {
    "id": 21,
    "tag": "doh_scanner",
    "label": "DoH Scanner",
    "description": "Connection with detected DoH server.",
    "category": {
      "tag": "encrypted_dns_detection",
      "label": "Encrypted DNS Detection"
    }
  },
  "type": "added",
  "version": "1.2.1"
}