Delete Index
Delete an index, it’s data and it’s configuration
Resource Information
This service uses the tomcat application on port 8080 by default. To see a list of default ports click here
The context for this API is /crafter-search, please prefix the API URLs with this context.
HTTP Verb
|
POST
|
URL
|
/api/2/admin/index/delete/:id |
Response Formats
|
JSON |
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
id
|
String
|
✓
|
The index ID.
|
delete_mode
|
String
|
What exactly to delete. If not
specified, only the index files will
will be deleted. If
ALL_DATA, alldata related to the index will be
deleted. If
ALL_DATA_AND_CONFIG,all data and configuration.
|
|
token
|
String
|
✓
|
The access token.
|
The access token could be optional depending on the configuration.
Example
Request
POST .../api/2/admin/index/delete/mysite?token=myAccessToken
{
"delete_mode": "ALL_DATA_AND_CONFIG"
}
Response
Status 204 NO CONTENT
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
204
|
||
404
|
{ "message" : "Index not found" } |
|
500
|
{ "message" : "Internal server error" } |
|
503
|
{ "message" : "Service unavailable, please try again later" } |