Intelligence API
Intelligence API
Introduction
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 following endpoints provide information on the intelligence supported by the Netify Agent:
| Data | Description |
|---|---|
| Intelligence Catalog | The list of supported intelligence modules. |
| 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
These integrator API endpoints provide payloads with the following top-level JSON properties:
- status_code: a status code number
- status_message: a human-readable status message
- status_fields: an array of validation errors (if any)
Additionally, the API sends standard HTTP response codes.
| Code | Response |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 409 | Conflict |
| 422 | Validation Error |
| 429 | Too Many Requests |
| 500 | Server Error |
Intelligence Catalog API
| Endpoint | https://agents.netify.ai/api/v2/integrator/intelligence/catalog |
The Intelligence Catalog provides a list of all the intelligence - past and present - supported by the Netify Agent.
If the Netify agent version is passed to the API 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).
ID and Tag
You can identify a intelligence by ID number (e.g. 120). The tag is only intended for user interfaces (UIs) and internal use -- it is not used in the Netify Agent. You can browse the list of IDs in the intelligence catalog.
Description
The description is a one or two-sentence description of the intelligence.
Category
Every intelligence is listed under a category. You can find a list of intelligence categories and associated IDs/tags here.
Introduced
The Netify Agent version where the intelligence was introduced.
Deprecated
The Netify Agent version where the intelligence 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 API
| Intelligence Categories | https://agents.netify.ai/api/v2/integrator/intelligence/categories |
Every intelligence is listed under a category. You can find a list of intelligence categories and associated IDs/tags here.
The category API provides a standard id, tag and label for each category.
Intelligence Category - JSON Example
{
"tag": "encrypted_dns_detection",
"label": "Encrypted DNS Detection"
},
{
"tag": "encryption_audit",
"label": "Encryption Audit"
},
...
Intelligence Release Log API
| Endpoint | https://agents.netify.ai/api/v2/integrator/intelligence/releaselog |
The Intelligence Release Log provides intelligence additions and deletions in release order.