Management APIs - Revision history

Alexei.baranov: /* Management APIs */

2021-11-02T17:13:53Z

‎Management APIs

2020-06-25T15:13:57Z

‎Management APIs

2020-06-25T14:59:04Z

2020-06-25T14:58:40Z

‎Management APIs

2020-05-22T16:21:31Z

‎Management APIs

2020-05-22T16:20:48Z

‎Management APIs

2020-05-22T11:23:20Z

‎GET_SWAGGER API

2020-05-21T15:47:41Z

2020-05-21T14:50:41Z

‎CLIENTS+/- API

2020-05-21T14:49:11Z

‎CLIENTS+/- API

@@ Line 10: / Line 10: @@
 example:
 <pre>https://192.168.0.233:8080</pre>
-Please look at our guides on how to obtain [[Auth_profile_SoapUI|Oauth2 token]] and than perform [[Manage_API_SoapUI|Managment api authorized call]] using Soap UI.
+Please look at our guides on how to obtain [[Auth_profile_SoapUI|Oauth2 token]] and than perform [[Managment_API_SoapUI|Managment api authorized call]] using Soap UI.
 == STATUS API ==
 This API returns status details of runing server instance.

@@ Line 10: / Line 10: @@
 example:
 <pre>https://192.168.0.233:8080</pre>
-Please look at our guides on how to obtain [[Auth_profile_SoapUI|Oauth2 token with Soap UI]], and than perform [[Manage_API_SoapUI|Managment api authorized call]].
+Please look at our guides on how to obtain [[Auth_profile_SoapUI|Oauth2 token]] and than perform [[Manage_API_SoapUI|Managment api authorized call]] using Soap UI.
 == STATUS API ==
 This API returns status details of runing server instance.

@@ Line 11: / Line 11: @@
 <pre>https://192.168.0.233:8080</pre>
 Please look at our guides on how to obtain [[Auth_profile_SoapUI|Oauth2 token with Soap UI]], and than perform [[Manage_API_SoapUI|Managment api authorized call]].
 == STATUS API ==
 This API returns status details of runing server instance.

@@ Line 10: / Line 10: @@
 example:
 <pre>https://192.168.0.233:8080</pre>
 == STATUS API ==

@@ Line 6: / Line 6: @@
 <pre>http[s]://<your_i2Rest_server></pre>
 where:
-* <tt>your_i2Rest_server</tt> - host name and optional port of i2Rest Server instance (defined in [[Gate_object|Management Gate Config]])
+* <tt>your_i2Rest_server</tt> - host name and optional port of management gate of the i2Rest Server instance (defined in [[Gate_object|Management Gate Config]])
 example:

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:Management APIs}}
 = Management APIs =
-Management APIs includes functions that can be used to do some management stuff - change runtime parameters, query current status of server instance, etc. OAuth2 token with [[i2Rest scopes#management_functions|Management_functions]] scope is required for any Management Api call.<br>
+Management APIs includes functions that can be used to do some management stuff - change runtime parameters, query current status of server instance, etc. OAuth2 token with [[i2Rest scopes#management_functions|management_functions]] scope is required for any Management Api call.<br>
 All the Management APIs are available on [[i2Rest Gates#management_gate|Management Gate endpoint]]. The URL is as follows:

@@ Line 292: / Line 292: @@
 </pre>
-== GET_SWAGGER API ==
+== GET_OPENAPI30 API ==
 This API returns OpenAPI 3.0 tag content of specified PCML mounting point.
-=== GET_SWAGGER API parameters ===
+=== GET_OPENAPI30 API parameters ===
-To call GET_SWAGGER API, you must send POST request with following JSON object as request body (media type 'application/json'):
+To call GET_OPENAPI30 API, you must send POST request with following JSON object as request body (media type 'application/json'):
 {| style="width: 100%; vertical-align:top; border-collapse:collapse" border="1"
 | style="width: 10%; padding: 5px"|'''Field'''
@@ Line 304: / Line 304: @@
 |style="padding: 5px"|command
 |style="padding: 5px"|string
-|style="padding: 5px"|'''REQUIRED''', "GET_SWAGGER" must be specified.<br/>
+|style="padding: 5px"|'''REQUIRED''', "GET_OPENAPI30" must be specified.<br/>
 The string containing command to call. This command "as is" will be called in session job
+|
@@ Line 317: / Line 317: @@
+|
 |}
-=== GET_SWAGGER API example ===
+=== GET_OPENAPI30 API example ===
 Request:
 <pre>
@@ Line 329: / Line 329: @@
+{
-	"command":"GET_SWAGGER",
+	"command":"GET_OPENAPI30",
 	"pcml_mount":"echo2"
+}

@@ Line 630: / Line 630: @@
 == CLIENTS+/- API ==
-This API allows you to adjust "clients_max" parameter of [[Gate_object|Gate Object]] (the highest amount of incoming connections) on each of representing i2Rest Gate servers. CLIENTS+ API call will increase "clients_max" parameter value by specified number, CLIENTS- API call will decrease "clients_max" parameter value by specified number.
+This API allows you to adjust "clients_max" parameter of [[Gate_object|Gate Object]] (the highest amount of incoming connections) on running server istance (each of representing i2Rest Gate servers). CLIENTS+ API call will increase "clients_max" parameter value by specified number, CLIENTS- API call will decrease "clients_max" parameter value by specified number.
 === CLIENTS+/- API parameters ===
 To call CLIENTS+/- API, you must send POST request with following JSON object as request body (media type 'application/json'):