Logging Library
[platform-oam.git] / docs / elkclient-server-api.rst
1 .. ===============LICENSE_START=======================================================
2 .. Acumos CC-BY-4.0
3 .. ===================================================================================
4 .. Copyright (C) 2019 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
5 .. ===================================================================================
6 .. This Acumos documentation file is distributed by AT&T and Tech Mahindra
7 .. under the Creative Commons Attribution 4.0 International License (the "License");
8 .. you may not use this file except in compliance with the License.
9 .. You may obtain a copy of the License at
10 ..
11 .. http://creativecommons.org/licenses/by/4.0
12 ..
13 .. This file is distributed on an "AS IS" BASIS,
14 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 .. See the License for the specific language governing permissions and
16 .. limitations under the License.
17 .. ===============LICENSE_END=========================================================
18
19 ==============================
20 ELK Client Service Server API
21 ==============================
22
23 This page provides a static view of the methods in the elkclient server.  Please note that a
24 running ELK Client server provides a more useful version of this information.  View the details
25 at a URL like the following, but check the server configuration for the exact port number
26 (e.g., "9006") and context root (e.g., "elkclient") to use::
27
28     http://localhost:9006/elkclient/swagger-ui.html
29         
30 Backup & Restore
31 ----------------
32
33 This section list features provided in this services.
34     * Get all the indices present in elastic search.
35     * Get all the repositories information present in elastic search.
36     * Get all the snapshot present in elastic search.
37     * Create elastic search repository.
38     * Create elastic search snapshot.
39     * Delete elastic search Indices.
40     * Delete elastic search repository.
41     * Delete elastic search snapshot.
42     * Restore elastic search snapshot.
43  
44 ELK Client APIs in Clio Release
45 ---------------------------------
46
47 This section lists the methods in version 3.0.0.
48
49 .. swaggerv2doc:: api/elkclient-api-docs-3.0.0.json
50
51
52