ELK Client Service Server API¶
This page provides a static view of the methods in the elkclient server. Please note that a running ELK Client server provides a more useful version of this information. View the details at a URL like the following, but check the server configuration for the exact port number (e.g., “9006”) and context root (e.g., “elkclient”) to use:
http://localhost:9006/elkclient/swagger-ui.html
Backup & Restore¶
- This section list features provided in this services.
- Get all the indices present in elastic search.
- Get all the repositories information present in elastic search.
- Get all the snapshot present in elastic search.
- Create elastic search repository.
- Create elastic search snapshot.
- Delete elastic search Indices.
- Delete elastic search repository.
- Delete elastic search snapshot.
- Restore elastic search snapshot.
ELK Client APIs in Clio Release¶
This section lists the methods in version 3.0.0.
elastic-search-service-controller¶
POST /restore/snapshot
Restore elasticstack snapshot.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| elkRestoreSnapshotRequest | body | elkRestoreSnapshotRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /create/snapshot
Create elasticstack snapshot.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| createSnapshotRequest | body | createSnapshotRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /create/repositories
Create Elasticstack repository.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| elkCreateRepositoriesRequest | body | elkCreateRepositoriesRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /all/archive
Ger all the archive snapshot.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /archive/action
Archive and Restore elasticstack snapshot.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| archiveRequest | body | archiveRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /all/snapshot
Get all the elasticsearch snapshot.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /delete/indices
Delete elasticstack Indices.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| elasticStackIndices | body | elasticStackIndices |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /delete/snapshot
Delete elasticstack snapshot.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| elkDeleteSnapshotRequest | body | elkDeleteSnapshotRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /all/repositories
Get all the elasticsearch repositories details of Elasticstack.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
POST /delete/repositories
Delete Elasticstack repository.
- Produces: [u’application/json’]
- Consumes: [u’application/json’]
Parameters
| Name | Position | Description | Type |
|---|---|---|---|
| elkDeleteRepositoriesRequest | body | elkDeleteRepositoriesRequest |
Responses
201 - Created
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
GET /all/indices
Get all the indices of Elasticstack.
- Produces: [u’application/json’]
Responses
200 - OK
404 - Not Found
403 - Forbidden
401 - Unauthorized
