Document Renderer Service - Health Check Endpoints

Introduction

In order to check if the service is online and accepting requests; a health check endpoint is available. This page describes how to use it and what is needed to use it.

Health Check Endpoint

The health check endpoint is mapped to the URI:

/health

The following responses can be expected:

// Service is healthy
{
	"status": "UP"
}

// Service is unhealthy
{
	"status": "DOWN"
}

// Service is degraded
{
	"status": "OUT_OF_SERVICE"
}

Authentication

In order to call the health check endpoint you need to use the user that was configured through the following properties.

See: Document Renderer Service Authentication Properties

This user is also the one you would use to call other endpoints on the document renderer.