Get Subscribed Protocols

The Get Protocols API provides a list of supported VPN protocols for a specific device type. This information is essential for the client application to determine the available connection options and present them to the user.

Get Protocols (v3)

• URL: <base url>/inventory/v3/protocols/<sDeviceType>
• Request Method: GET

Use this API to get a complete list of subscribed Protocols.

Returns JSON object that contains protocol details.

Payload

Response

Sample Response

{
  "header": {
    "response_code": 1,
    "message": "success"
  },
  "body": {
    "protocols": [{
      "id": 1,
      "name": "TCP",
      "protocol": "TCP",
      "number": 1,
      "port_number": 0,
      "protocol_switch": [],
      "is_multiport": 0,
      "multiport_range": 0,
    }]
  }
}

{
  "header": {
    "code": 1,
    "message": "success"
    "response_code": 1
  },
  "body": {
    "protocols": [{
      "id": 1,
      "name": "TCP",
      "protocol": "TCP",
      "number": 1,
      "port_number": 0,
      "is_multiport": 0,
      "multiport_range": 0,
      "protocol_switch": []
    }]
  }
}