Valstorm LogoDev

search-admin Endpoints

All endpoints for the search-admin API group. Great for feeding into an LLM context.

GET

/v1/search-admin/connection

Check OpenSearch Connection

Checks the connection status to the OpenSearch cluster. - **Requires admin privileges.**

Responses
200
Successful Response
application/json
{}
404
Not found
API Runner
GET

/v1/search-admin/index/app-indexes

List Application Indexes

Retrieves a list of all application-specific index names (prefixed with 'vs_') currently in the OpenSearch cluster. - **Requires admin privileges.**

Responses
200
Successful Response
application/json
{}
404
Not found
API Runner
GET

/v1/search-admin/index/all-system

List All System Indexes

Retrieves a list of ALL index names currently in the OpenSearch cluster, including protected system indexes. - **Requires admin privileges.**

Responses
200
Successful Response
application/json
{}
404
Not found
API Runner
DELETE

/v1/search-admin/flush-db

Flush Application Indexes

**DANGEROUS OPERATION.** Deletes all application-specific ('vs_*') indexes. This is intended for resetting the testing environment. - **Requires admin privileges.**

Responses
200
Successful Response
application/json
{}
404
Not found
API Runner
POST

/v1/search-admin/index/docs

Trigger Documentation Indexing

Manually triggers the OpenSearch indexing task for documentation site data. - **run_async**: If `true`, the task runs in the background and the API returns a task ID. If `false` (default), the API waits for the task to complete and returns the full result. - **Requires admin privileges.**

Parameters
index_name
in: query
type: string
run_async
in: query
type: boolean
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
POST

/v1/search-admin/index/{index_name}

Create Index

Creates a new application-specific ('vs_*') index in OpenSearch. - **index_name**: The base name of the index to create (e.g., 'my_index'). - **settings**: (Optional) A JSON body with index settings. - **Requires admin privileges.**

Parameters
index_name*
in: path
type: string
Request Body
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": true,
        "title": "Settings"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
GET

/v1/search-admin/index/{index_name}

Get Index Information

Retrieves information for a specific application-specific ('vs_*') index. - **index_name**: The base name of the index to retrieve. - **Requires admin privileges.**

Parameters
index_name*
in: path
type: string
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
DELETE

/v1/search-admin/index/{index_name}

Delete Index

Deletes a specific application-specific ('vs_*') index. - **index_name**: The base name of the index to delete. - **Requires admin privileges.**

Parameters
index_name*
in: path
type: string
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
GET

/v1/search-admin/index/{index_name}/documents

Get All Documents in Index

Retrieves all documents from a specific application-specific ('vs_*') index. Mainly for debugging to verify index contents. - **index_name**: The base name of the index to query. - **limit**: The maximum number of documents to return. - **Requires admin privileges.**

Parameters
index_name*
in: path
type: string
limit
in: query
type: integer
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
PUT

/v1/search-admin/index/{index_name}/settings

Update Index Settings

Updates the settings of an existing application-specific ('vs_*') index. - **index_name**: The base name of the index to update. - **settings**: A JSON body with the settings to update. - **Requires admin privileges.**

Parameters
index_name*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": true,
        "title": "Settings"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner