IP Protocol API

When integrating Netify into a user interface (UI), it is often necessary to present the end user with IP protocol information. An integrator API endpoint is available to fetch Netify's IP protocol catalog as a JSON object.

The API returns JSON objects containing IDs, tags, human-friendly labels, and status and policy guidance for each IP protocol. Integrators can pass the optional version parameter to limit results to a specific agent release.

Endpoint Summary

The following endpoint provides information on the IP protocols supported by the Netify Agent:

Data	Description
IP Protocol Catalog	The list of supported IP protocols.

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)

IP Protocol Catalog Endpoint

GET

https://hub.netify.ai/api/v2/integrator/ip_protocols/catalog

Returns the list of all IP protocols 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 IP 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).

IP Protocol Attributes

id

integer

The ID number associated with the IP protocol.

tag

string

The tag associated with the IP 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 IP protocol.

abbreviation

string

The IP protocol abbreviation, as commonly used in networking references and RFCs.

description

string

A one or two-sentence description of the IP protocol.

home_page

object

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

ipv6_extension_header

boolean

Indicates whether the IP protocol is an IPv6 extension header.

keyword

string

The IANA-registered protocol keyword for the IP protocol.

status

string

The current status of the IP protocol, e.g. active.

IP Protocol Object - JSON Example

{
    "id": 1,
    "tag": "icmp",
    "label": "Internet Control Message Protocol",
    "abbreviation": "ICMP",
    "description": "ICMP is used by hosts ...",
    "home_page": {
        "url": "https://en.wikipedia.org/...",
        "text": "Internet Control Message Protocol"
    },
    "ipv6_extension_header": false,
    "keyword": "ICMP",
    "status": "active",
}