diff --git a/scs_api.server_public.md b/scs_api.server_public.md index 233ff08d21c65cffb28e8e5eb48b74342a64d62d..2649b2bcc4889411a4eab5ff36e0026f58a73032 100644 --- a/scs_api.server_public.md +++ b/scs_api.server_public.md @@ -15,11 +15,11 @@ is 6 requests per minute. Exceeding the limit will lead to your IP address being temporarily blocked from making further requests. The block will automatically be lifted by waiting an hour. -- api revision: `26bc2dbc / 2020-06-08 07:33:47 +0200` +- api revision: `d110fd35 / 2020-06-08 07:33:47 +0200` -- api version: `0.9-238-g26bc2db` +- api version: `0.9-238-gd110fd3` -- apidoc building date: `2020-06-08 12:54:25 +0000` +- apidoc building date: `2020-06-08 12:58:10 +0000` Summary ------------------------------------------------------------------------------------- @@ -148,7 +148,9 @@ Query Parameters - **planned** – returns dedicated times for all clusters which are now active or scheduled in the future + Response JSON Object + - **cluster\_type** (*string*) – cluster id - **dateEfficiency** (*string*) – maintenance start date @@ -196,7 +198,9 @@ Request JSON Object - **it4ifreetoken** (*string*) – token - **cluster** (*string*) – cluster id or ‘all’ + Response JSON Object + - **cluster** (*string*) – cluster id or ‘all’ - **fs** (*string*) – filesystem name @@ -269,7 +273,9 @@ Request JSON Object - **login** (*string*) – account id - **it4ifreetoken** (*string*) – token + Response JSON Object + - **login** (*string*) – account id - **pi\_login** (*string*) – PI account id @@ -387,7 +393,9 @@ Query Parameters - **important** – returns only important messages - **all** – returns all messages + Response JSON Object + - **author** (*string*) – author of the message - **category** (*string*) – message category @@ -454,7 +462,9 @@ Status Codes **GET /api/v1/ping** A service for testing connection to API. + Response JSON Object + - **message** (*string*) – reply message ‘pong’ Status Codes @@ -478,7 +488,9 @@ Status Codes **GET /api/v1/version** Returns basic information about the API. + Response JSON Object + - **hostname** (*string*) – system hostname - **revision** (*string*) – API revision / build time