Information API

Server Information

These endpoints are purely informational and not directly tied to the functionality provided by SC-Search.

Health

`GET /healthz`

Retrieves the health status of the server. This endpoint does not require authentication.

Note: The “z” suffix is deliberate. It is a kubernetes convention to avoid potentially conflicting with pre-existing “health” endpoints.

Example Call

curl -X GET https://telicent.core.domain/api/search/healthz

Response

Description

200 OK: The server is healthy.
- Contains HealthStatus:
  - healthy (boolean): Indicates if the server is healthy.
  - reasons (array of string, optional): Reasons why the server is unhealthy.
  - config (object): Configuration details (e.g., searchIndex, searchClient).
503 Service Unavailable: The server is unhealthy. Contains HealthStatus.

Example

{
  "healthy": true,
  "config": {
    "authorization": "enabled",
    "searchClientReady": true,
    "authentication": "enabled"
  }
}

Note: Fields have been removed from the config section of the example due to the confidential nature of the nature of the data involved.

Version

`GET /version-info`

Retrieves version information for the server and its three components: Search API, Search API Server, and Elastic Indexer.

This endpoint does not require authentication.

Example Call:search_version

curl -X GET https://telicent.core.domain/api/search/version-info

Response

Description

200 OK: Server version information.
- Contains VersionInfo:
  - name (string): Component name.
  - version (string): Component version.
  - artifactId (string, optional): Maven artifact ID.

Example

{
  "search-api": {
    "buildEnv": "Mac OS X 15.5 (aarch64)",
    "groupId": "io.telicent.smart-caches.search",
    "name": "Telicent Smart Caches - Search - Core API",
    "version": "0.17.2",
    "artifactId": "search-api",
    "revision": "1bd2979fe7c6884c0832445cc64fef5da5924bb9",
    "timestamp": "2025-06-27 09:38:14"
  },
  "search-index-elastic": {
    "buildEnv": "Mac OS X 15.5 (aarch64)",
    "groupId": "io.telicent.smart-caches.search",
    "name": "Telicent Smart Caches - Search - ElasticSearch",
    "artifactId": "search-index-elastic",
    "version": "0.17.2",
    "revision": "1bd2979fe7c6884c0832445cc64fef5da5924bb9",
    "timestamp": "2025-06-27 09:38:20"
  },
  "search-api-server": {
    "buildEnv": "Mac OS X 15.5 (aarch64)",
    "groupId": "io.telicent.smart-caches.search",
    "name": "Telicent Smart Caches - Search - API Server",
    "artifactId": "search-api-server",
    "version": "0.17.2",
    "revision": "1bd2979fe7c6884c0832445cc64fef5da5924bb9",
    "timestamp": "2025-06-27 09:38:22"
  }
}