{"id":10021,"date":"2024-06-10T11:18:20","date_gmt":"2024-06-10T11:18:20","guid":{"rendered":"https:\/\/www.purewl.com\/developer\/docs\/api-reference\/api-reference\/inventory-management\/protocols\/"},"modified":"2025-02-19T10:25:09","modified_gmt":"2025-02-19T10:25:09","slug":"protocols","status":"publish","type":"docs","link":"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/inventory-management\/protocols\/","title":{"rendered":"Get Subscribed Protocols"},"content":{"rendered":"\n<p>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.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"get-countries-v3\">Get Protocols (v3)<\/h2>\n\n\n\n<ul>\n<li><strong>URL:&nbsp;<\/strong>&lt;base url&gt;\/inventory\/v3\/protocols\/&lt;sDeviceType&gt;<\/li>\n\n\n\n<li><strong>Request Method:&nbsp;<\/strong>GET<\/li>\n<\/ul>\n\n\n\n<p>Use this API to get a complete list of subscribed Protocols.<\/p>\n\n\n\n<p>Returns JSON object that contains protocol details.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Payload<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Key<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Type<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Pass in<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>X-AccessToken<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Header<\/td><td class=\"has-text-align-left\" data-align=\"left\"><kbd>accessToken<\/kbd> retrieved from <a href=\"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/api-access-authentication\/#get-access-token\" data-type=\"link\" data-id=\"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/inventory-management\/countries\/\" target=\"_blank\" rel=\"noreferrer noopener\">Get Access Token<\/a> endpoint<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>sDeviceType<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Path<\/td><td class=\"has-text-align-left\" data-align=\"left\">Type of device<br>Possible values:&nbsp;<strong>android<\/strong>&nbsp;|&nbsp;<strong>ios<\/strong>&nbsp;|&nbsp;<strong>mac<\/strong>&nbsp;|&nbsp;<strong>windows<\/strong><\/td><\/tr><\/tbody><\/table><figcaption class=\"wp-element-caption\">(*) Required Parameter<\/figcaption><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Response<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Key<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Type<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>header<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON<\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON object that describes return code and message.<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>body<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON<\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON object that returns protocols array containing objects<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>protocols<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">Array<\/td><td class=\"has-text-align-left\" data-align=\"left\">Array of object that contains details related to protocols.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Sample Response<\/h3>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism off-numbers lang-json\" data-lang=\"JSON\" data-show-lang=\"1\"><code>{\n  &quot;header&quot;: {\n    &quot;response_code&quot;: 1,\n    &quot;message&quot;: &quot;success&quot;\n  },\n  &quot;body&quot;: {\n    &quot;protocols&quot;: [{\n      &quot;id&quot;: 1,\n      &quot;name&quot;: &quot;TCP&quot;,\n      &quot;protocol&quot;: &quot;TCP&quot;,\n      &quot;number&quot;: 1,\n      &quot;port_number&quot;: 0,\n      &quot;protocol_switch&quot;: [],\n      &quot;is_multiport&quot;: 0,\n      &quot;multiport_range&quot;: 0,\n    }]\n  }\n}<\/code><\/pre><\/div>\n\n\n\n<div class=\"wp-block-group\"><div class=\"wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained\">\n<h2 class=\"wp-block-heading\">Get Protocols (v2)<\/h2>\n\n\n\n<ul>\n<li><strong>URL:&nbsp;<\/strong>&lt;base url&gt;\/inventory\/v2\/protocols\/&lt;sDeviceType&gt;<\/li>\n\n\n\n<li><strong>Request Method:&nbsp;<\/strong>GET<\/li>\n<\/ul>\n\n\n\n<p>Use this API to get a complete list of subscribed Protocols.<\/p>\n\n\n\n<p>Returns JSON object that contains protocol details.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Payload<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Key<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Type<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Pass in<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>X-AccessToken<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Header<\/td><td class=\"has-text-align-left\" data-align=\"left\"><kbd>accessToken<\/kbd> retrieved from <a href=\"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/api-access-authentication\/#get-access-token\" data-type=\"link\" data-id=\"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/inventory-management\/countries\/\" target=\"_blank\" rel=\"noreferrer noopener\">Get Access Token<\/a> endpoint<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>sDeviceType<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Path<\/td><td class=\"has-text-align-left\" data-align=\"left\">Type of device<br>Possible values:&nbsp;<strong>android<\/strong>&nbsp;|&nbsp;<strong>ios<\/strong>&nbsp;|&nbsp;<strong>mac<\/strong>&nbsp;|&nbsp;<strong>windows<\/strong><\/td><\/tr><\/tbody><\/table><figcaption class=\"wp-element-caption\">(*) Required Parameter<\/figcaption><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Response<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Key<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Type<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>header<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON<\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON object that describes return code and message.<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>body<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON<\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON object that returns protocols array containing objects.<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>protocols<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">Array<\/td><td class=\"has-text-align-left\" data-align=\"left\">Array of object that contains details related to protocols.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Sample Response<\/h3>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism off-numbers lang-json\" data-lang=\"JSON\" data-show-lang=\"1\"><code>{\n  &quot;header&quot;: {\n    &quot;code&quot;: 1,\n    &quot;message&quot;: &quot;success&quot;\n    &quot;response_code&quot;: 1\n  },\n  &quot;body&quot;: {\n    &quot;protocols&quot;: [{\n      &quot;id&quot;: 1,\n      &quot;name&quot;: &quot;TCP&quot;,\n      &quot;protocol&quot;: &quot;TCP&quot;,\n      &quot;number&quot;: 1,\n      &quot;port_number&quot;: 0,\n      &quot;is_multiport&quot;: 0,\n      &quot;multiport_range&quot;: 0,\n      &quot;protocol_switch&quot;: []\n    }]\n  }\n}<\/code><\/pre><\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>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) Use this API to get a complete list of subscribed Protocols. Returns JSON object that contains [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":9998,"menu_order":3,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"acf":[],"_links":{"self":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10021"}],"collection":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/comments?post=10021"}],"version-history":[{"count":8,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10021\/revisions"}],"predecessor-version":[{"id":10730,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10021\/revisions\/10730"}],"up":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/9998"}],"wp:attachment":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/media?parent=10021"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/doc_tag?post=10021"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}