44< title > Contiv API documentation</ title >
55< meta http-equiv ="X-UA-Compatible " content ="IE=edge ">
66< meta http-equiv ="Content-Type " content ="text/html; charset=US-ASCII ">
7- < meta name ="generator " content ="https://github.com/raml2html/raml2html 5.0 .0 ">
7+ < meta name ="generator " content ="https://github.com/raml2html/raml2html 6.3 .0 ">
88< link rel ="stylesheet " href ="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css ">
99< link rel ="stylesheet " href ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/styles/default.min.css ">
1010< script type ="text/javascript " src ="https://code.jquery.com/jquery-1.11.0.min.js "> </ script > < script type ="text/javascript " src ="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js "> </ script > < script type ="text/javascript " src ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/highlight.min.js "> </ script > < script type ="text/javascript ">
212212< h1 > Contiv API documentation < small > version v1</ small >
213213</ h1 >
214214< p > https://{serverfqdn}:10000/api/{version}</ p >
215+ < p > Contiv API Specification</ p >
215216< ul >
216217< li >
217218< strong > serverfqdn</ strong > : < em > required (string)</ em >
@@ -231,7 +232,7 @@ <h1>Contiv API documentation <small>version v1</small>
231232< a class ="collapsed " data-toggle ="collapse " href ="#panel_auth_proxy_health "> < span class ="parent "> /auth_proxy</ span > /health/</ a > < span class ="methods "> < a href ="#auth_proxy_health_get "> < span class ="badge badge_get "> get</ span > </ a > </ span >
232233</ h4 > </ div >
233234< div id ="panel_auth_proxy_health " class ="panel-collapse collapse "> < div class ="panel-body "> < div class ="list-group "> < div onclick ="window.location.href = '#auth_proxy_health_get' " class ="list-group-item ">
234- < span class ="badge badge_get "> get</ span > < div class ="method_description "> < p > Returns the health status of auth_proxy and its netmaster</ p > </ div >
235+ < span class ="badge badge_get "> get</ span > < div class ="method_description "> < p > Returns the health status of Contiv API server and its netmaster</ p > </ div >
235236< div class ="clearfix "> </ div >
236237</ div > </ div > </ div > </ div >
237238< div class ="modal fade " tabindex ="0 " id ="auth_proxy_health_get "> < div class ="modal-dialog "> < div class ="modal-content ">
@@ -240,7 +241,7 @@ <h1>Contiv API documentation <small>version v1</small>
240241< span class ="badge badge_get "> get</ span > < span class ="parent "> /auth_proxy</ span > /health/</ h4 >
241242</ div >
242243< div class ="modal-body ">
243- < div class ="alert alert-info "> < p > Returns the health status of auth_proxy and its netmaster</ p > </ div >
244+ < div class ="alert alert-info "> < p > Returns the health status of Contiv API server and its netmaster</ p > </ div >
244245< ul class ="nav nav-tabs "> < li class ="active "> < a href ="#auth_proxy_health_get_response " data-toggle ="tab "> Response</ a > </ li > </ ul >
245246< div class ="tab-content "> < div class ="tab-pane active " id ="auth_proxy_health_get_response ">
246247< h2 > HTTP status code < a href ="http://httpstatus.es/200 " target ="_blank "> 200</ a >
@@ -302,7 +303,7 @@ <h3>Body</h3>
302303< p > < strong > Type</ strong > : object</ p >
303304< strong > Properties</ strong > < ul >
304305< li >
305- < strong > username</ strong > : < em > required (string)</ em > < p > user name . If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)</ p >
306+ < strong > username</ strong > : < em > required (string)</ em > < p > username . If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)</ p >
306307</ li >
307308< li >
308309< strong > password</ strong > : < em > required (string)</ em >
@@ -337,7 +338,7 @@ <h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a>
337338< a class ="collapsed " data-toggle ="collapse " href ="#panel_auth_proxy_version "> < span class ="parent "> /auth_proxy</ span > /version/</ a > < span class ="methods "> < a href ="#auth_proxy_version_get "> < span class ="badge badge_get "> get</ span > </ a > </ span >
338339</ h4 > </ div >
339340< div id ="panel_auth_proxy_version " class ="panel-collapse collapse "> < div class ="panel-body "> < div class ="list-group "> < div onclick ="window.location.href = '#auth_proxy_version_get' " class ="list-group-item ">
340- < span class ="badge badge_get "> get</ span > < div class ="method_description "> < p > Returns the auth_proxy version</ p > </ div >
341+ < span class ="badge badge_get "> get</ span > < div class ="method_description "> < p > Returns the Contiv API server version</ p > </ div >
341342< div class ="clearfix "> </ div >
342343</ div > </ div > </ div > </ div >
343344< div class ="modal fade " tabindex ="0 " id ="auth_proxy_version_get "> < div class ="modal-dialog "> < div class ="modal-content ">
@@ -346,7 +347,7 @@ <h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a>
346347< span class ="badge badge_get "> get</ span > < span class ="parent "> /auth_proxy</ span > /version/</ h4 >
347348</ div >
348349< div class ="modal-body ">
349- < div class ="alert alert-info "> < p > Returns the auth_proxy version</ p > </ div >
350+ < div class ="alert alert-info "> < p > Returns the Contiv API server version</ p > </ div >
350351< ul class ="nav nav-tabs "> < li class ="active "> < a href ="#auth_proxy_version_get_response " data-toggle ="tab "> Response</ a > </ li > </ ul >
351352< div class ="tab-content "> < div class ="tab-pane active " id ="auth_proxy_version_get_response ">
352353< h2 > HTTP status code < a href ="http://httpstatus.es/200 " target ="_blank "> 200</ a >
@@ -1702,6 +1703,9 @@ <h3>Body</h3>
17021703< li >
17031704< strong > netProfile</ strong > : < em > required (string)</ em >
17041705</ li >
1706+ < li >
1707+ < strong > cfgdTag</ strong > : < em > required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em >
1708+ </ li >
17051709</ ul >
17061710</ li >
17071711< li >
@@ -1726,6 +1730,9 @@ <h3>Body</h3>
17261730< li >
17271731< strong > availableIPAddresses</ strong > : < em > required (string)</ em > < p > Available IP addresses</ p >
17281732</ li >
1733+ < li >
1734+ < strong > groupTag</ strong > : < em > required (string)</ em > < p > Derived EndpointGroup Tag</ p >
1735+ </ li >
17291736</ ul >
17301737</ li >
17311738</ ul >
@@ -2083,6 +2090,9 @@ <h3>Body</h3>
20832090< li >
20842091< strong > nwType</ strong > : < em > required (string - pattern: ^(infra|data)$)</ em > < p > Network Type</ p >
20852092</ li >
2093+ < li >
2094+ < strong > cfgdTag</ strong > : < em > required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em > < p > Configured Network Tag</ p >
2095+ </ li >
20862096</ ul >
20872097</ li >
20882098< li >
@@ -2110,6 +2120,9 @@ <h3>Body</h3>
21102120< p > < strong > Items</ strong > : endpoint</ p >
21112121< div class ="items "> < ul > </ ul > </ div >
21122122</ li >
2123+ < li >
2124+ < strong > networkTag</ strong > : < em > required (string)</ em > < p > Derived Network Tag</ p >
2125+ </ li >
21132126</ ul >
21142127</ li >
21152128</ ul >
@@ -2545,6 +2558,9 @@ <h3>Body</h3>
25452558< li >
25462559< strong > nwType</ strong > : < em > required (string - pattern: ^(infra|data)$)</ em > < p > Network Type</ p >
25472560</ li >
2561+ < li >
2562+ < strong > cfgdTag</ strong > : < em > required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em > < p > Configured Network Tag</ p >
2563+ </ li >
25482564</ ul > </ div >
25492565</ li >
25502566< li >
@@ -2572,6 +2588,9 @@ <h3>Body</h3>
25722588< li >
25732589< strong > netProfile</ strong > : < em > required (string)</ em >
25742590</ li >
2591+ < li >
2592+ < strong > cfgdTag</ strong > : < em > required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em >
2593+ </ li >
25752594</ ul > </ div >
25762595</ li >
25772596< li >
@@ -3669,6 +3688,9 @@ <h3>Body</h3>
36693688< li >
36703689< strong > netProfile</ strong > : < em > required (string)</ em >
36713690</ li >
3691+ < li >
3692+ < strong > cfgdTag</ strong > : < em > required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em >
3693+ </ li >
36723694</ ul > </ div >
36733695</ div >
36743696< div class ="tab-pane " id ="endpointgroups_get_securedby ">
@@ -3765,6 +3787,9 @@ <h3>Body</h3>
37653787< li >
37663788< strong > netProfile</ strong > : < em > required (string)</ em >
37673789</ li >
3790+ < li >
3791+ < strong > cfgdTag</ strong > : < em > required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em >
3792+ </ li >
37683793</ ul >
37693794< h2 > HTTP status code < a href ="http://httpstatus.es/404 " target ="_blank "> 404</ a >
37703795</ h2 >
@@ -3839,6 +3864,9 @@ <h3>Body</h3>
38393864< li >
38403865< strong > netProfile</ strong > : < em > required (string)</ em >
38413866</ li >
3867+ < li >
3868+ < strong > cfgdTag</ strong > : < em > required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em >
3869+ </ li >
38423870</ ul >
38433871< h2 > HTTP status code < a href ="http://httpstatus.es/404 " target ="_blank "> 404</ a >
38443872</ h2 >
@@ -3909,6 +3937,9 @@ <h3>Body</h3>
39093937< li >
39103938< strong > netProfile</ strong > : < em > required (string)</ em >
39113939</ li >
3940+ < li >
3941+ < strong > cfgdTag</ strong > : < em > required (string - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em >
3942+ </ li >
39123943</ ul >
39133944</ div >
39143945< div class ="tab-pane " id ="endpointgroups__tenantname___groupname__post_response ">
@@ -5061,6 +5092,9 @@ <h3>Body</h3>
50615092< li >
50625093< strong > nwType</ strong > : < em > required (string - pattern: ^(infra|data)$)</ em > < p > Network Type</ p >
50635094</ li >
5095+ < li >
5096+ < strong > cfgdTag</ strong > : < em > required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em > < p > Configured Network Tag</ p >
5097+ </ li >
50645098</ ul > </ div >
50655099</ div >
50665100< div class ="tab-pane " id ="networks_get_securedby ">
@@ -5156,6 +5190,9 @@ <h3>Body</h3>
51565190< li >
51575191< strong > nwType</ strong > : < em > required (string - pattern: ^(infra|data)$)</ em > < p > Network Type</ p >
51585192</ li >
5193+ < li >
5194+ < strong > cfgdTag</ strong > : < em > required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em > < p > Configured Network Tag</ p >
5195+ </ li >
51595196</ ul >
51605197</ div >
51615198< div class ="tab-pane " id ="networks__tenantname___networkname__put_response ">
@@ -5192,6 +5229,9 @@ <h3>Body</h3>
51925229< li >
51935230< strong > nwType</ strong > : < em > required (string - pattern: ^(infra|data)$)</ em > < p > Network Type</ p >
51945231</ li >
5232+ < li >
5233+ < strong > cfgdTag</ strong > : < em > required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em > < p > Configured Network Tag</ p >
5234+ </ li >
51955235</ ul >
51965236< h2 > HTTP status code < a href ="http://httpstatus.es/404 " target ="_blank "> 404</ a >
51975237</ h2 >
@@ -5272,6 +5312,9 @@ <h3>Body</h3>
52725312< li >
52735313< strong > nwType</ strong > : < em > required (string - pattern: ^(infra|data)$)</ em > < p > Network Type</ p >
52745314</ li >
5315+ < li >
5316+ < strong > cfgdTag</ strong > : < em > required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em > < p > Configured Network Tag</ p >
5317+ </ li >
52755318</ ul >
52765319< h2 > HTTP status code < a href ="http://httpstatus.es/404 " target ="_blank "> 404</ a >
52775320</ h2 >
@@ -5348,6 +5391,9 @@ <h3>Body</h3>
53485391< li >
53495392< strong > nwType</ strong > : < em > required (string - pattern: ^(infra|data)$)</ em > < p > Network Type</ p >
53505393</ li >
5394+ < li >
5395+ < strong > cfgdTag</ strong > : < em > required (string - maxLength: 128 - pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]))?$)</ em > < p > Configured Network Tag</ p >
5396+ </ li >
53515397</ ul >
53525398</ div >
53535399< div class ="tab-pane " id ="networks__tenantname___networkname__post_response ">
0 commit comments