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.
Endpoint Summary
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
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
Parameters
version
stringIntelligence Attributes
id
integertag
stringlabel
stringdescription
stringcategory
objectsupported
stringdeprecated
stringIntelligence 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
Intelligence Category Attributes
tag
stringlabel
stringIntelligence Category - JSON Example
{
"tag": "encrypted_dns_detection",
"label": "Encrypted DNS Detection"
},
{
"tag": "encryption_audit",
"label": "Encryption Audit"
},
...