Dynamic Search API

Use the implemented index, document, console-query, and analytics endpoints on your Genorbex deployment.

Open Search console

Request formats

Create indexes with name, optional description, groupName, settings, mappings, and aliases. Use the returned internal index ID for document operations.

The console execute endpoint expects query as a JSON-encoded string, not a nested object. Start with match_all and confirm results before building more involved queries.

Responses and errors

Check the HTTP status and returned error before using a result. Index listing returns indices and pagination. Document listing returns documents, total, from, and size. Resource policies may reject an otherwise valid request.

API endpoints

Use your Genorbex deployment’s origin followed by the path below. Replace IDs with resources accessible to your account. Authentication and permissions are checked by each endpoint.

GET /api/dynamic-search/indices

Lists visible indexes and pagination.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

POST /api/dynamic-search/indices

Creates an index.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

Example JSON body

{
  "name": "example_index",
  "description": "Example documents"
}

GET /api/dynamic-search/indices/{id}

Reads an index by internal ID.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

DELETE /api/dynamic-search/indices/{id}

Deletes an accessible index; review this destructive action before sending it.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

GET /api/dynamic-search/documents

Lists documents; supply indexId and optionally query, from, and size as query parameters.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

POST /api/dynamic-search/documents

Indexes a document or an explicitly supported bulk request.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

Example JSON body

{
  "indexId": "YOUR_INDEX_ID",
  "documentId": "example-1",
  "document": {
    "title": "Example document",
    "content": "Searchable content"
  }
}

POST /api/dynamic-search/console/execute

Executes a supported console query.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

Example JSON body

{
  "indexId": "YOUR_INDEX_ID",
  "query": "{\"query\":{\"match_all\":{}},\"size\":10}"
}

GET /api/dynamic-search/analytics

Returns analytics for the permitted scope.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

Need help with your setup? Visit the Help Center or contact Genorbex.