Protocol API

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

The API returns JSON objects containing IDs, tags, human-friendly labels, categories, and version information. Integrators can pass the optional version parameter to limit results to a specific agent release.

Quick Links - Integration APIs

Endpoint Summary

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

Data	Description
Protocol Catalog	The list of supported protocols.
Protocol Categories	The list of categories used by protocols.
Protocol Release Logs	The log of protocol 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)

Protocol Catalog Endpoint

GET

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

Returns the list of all protocols - 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 protocols supported in the specified version. You can specify the full version (e.g. 5.2.1), or a major version number (e.g. 5.2).

Protocol Attributes

id

integer

The ID number associated with the protocol.

tag

string

The tag associated with the protocol. The tag is only intended for user interfaces (UIs) and internal use -- it is not used in the Netify Agent.

label

string

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

full_label

string

The full_label (if shown) provides a more formal name.

abbreviation

string

The protocol abbreviation is provided if it is in wide use.

description

string

A one or two-sentence description of the protocol.

home_page

object

A small object that defines both the url and associated text for the protocol home page.

introduced

string

The Netify Agent version where the protocol was introduced.

deprecated

string

The Netify Agent version where the protocol was deprecated.

Protocol Object - JSON Example

{
    "id": 37,
    "tag": "bittorrent",
    "label": "BitTorrent",
    "full_label": "BitTorrent",
    "description": "BitTorrent is the most popular peer-to-peer file sharing protocol. It is typically used to download large files, as well as movies, music and other media.",
    "home_page": {
        "url": "https://en.wikipedia.org/wiki/BitTorrent",
        "text": "BitTorrent"
    },
    "category": {
        "id": 5,
        "tag": "file-sharing",
        "label": "File Sharing"
    },
    "introduced": "2.88",
    "deprecated": ""
}

Protocol Categories Endpoint

GET

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

Returns the list of protocol categories.

Parameters

version

string

If the Netify agent version is passed as a parameter to the endpoint, the results will only include the categories supported in the specified version. You can specify the full version (e.g. 5.2.1), or a major version number (e.g. 5.2). Currently, all versions share the same categories, but this may not be true in future releases.

Protocol Category Attributes

id

integer

The protocol category ID.

tag

string

The protocol category tag.

label

string

The category label.

Protocol Categories - JSON Example

{
    "id": 3,
    "tag": "advertiser",
    "label": "Advertiser"
},
{
    "id": 4,
    "tag": "entertainment",
    "label": "Arts and Entertainment"
},
...

Protocol Release Log Endpoint

GET

https://agents.netify.ai/api/v2/integrator/protocols/release-log

Returns the protocol release log with detailed version information.