Get a Tenant Health Report - Fluid Topics - 3.8

Fluid Topics Troubleshooting Guide

Product
Fluid Topics
FT_Version
3.8
Platform
RHEL
Category
Reference Guide
language
English

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

Method

Endpoint

GET

https://$SERVER:PORT/$TENANT_ID/api/health?components=search,contentRepository,mongoDb

Where:

  • $SERVER:PORT: is the Fluid Topics root server name and port, e.g. fluidtopics-replyA:8080
  • $TENANT_ID: is the tenant identifier, e.g. MyPortal
  • components: is an optional argument to filter the components to check

The web service also supports the tenant domain name.

Method

Endpoint

GET

https://$TENANT_VHOST/api/health?components=search,contentRepository,mongoDb

Where:

  • $TENANT_VHOST: is the Fluid Topics tenant domain name, e.g. doc.antidot.net
  • components: is 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

Output Example

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