/index

Builds all indexes.

post

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Body

*/*

Starts a new indexing operation.

plananyOptional

Set to true to plan the index building.

toIndexanyOptional

Set to true to perform the index building.

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

*/*

post

/index/build

HTTPcURLJavaScriptPython

POST /api/rest/index/build HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 26

{
  "plan": null,
  "toIndex": []
}

{
  "code": "text",
  "message": "text"
}

Gets all index plans.

get

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

/index/plan

HTTPcURLJavaScriptPython

GET /api/rest/index/plan HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}