Get a tenant health report - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service returns the health report of a Fluid Topics tenant hosted on the server.

Method Endpoint
GET /api/health?components=search,contentRepository,mongoDb
Query string parameter Type Required? Description
components String Yes An optional argument to filter the components to check

The web service also supports the tenant domain name.

Method Endpoint
GET /api/health?components=search,contentRepository,mongoDb
Query string parameter Type Required? Description
components String Yes An optional argument to filter the components to check.

The available components are the following:
  • search: status of the search engine in the Home Page and Search Page.
  • contentRepository: status of content rendering in the Reader Page.
  • mongoDb: status of the Fluid Topics Mongo DB database.
  • pdfServer: status of the PDF Server which delivers the PDF export of Personal Books.

Response body

{
  "status": "UP",
  "search": {
    "status": "UP"
  },
  "contentRepository": {
    "status": "UP"
  },
  "mongoDb": {
    "status": "UP"
  }
}