---
title: "Health check"
slug: "s3suite94-health-check"
updated: 2026-10-27T18:42:16Z
published: 2026-10-27T18:42:16Z
canonical: "docs.onespan.com/s3suite94-health-check"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onespan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Health check

| URL: /nnlgateway/health Method: GET |
| --- |

---

Health Check is a REST endpoint provided by the Digipass S3 API Server to check if the servers and databases are operating normally.

## Request

| **Attribute** | **Description** |
| --- | --- |
| ```plaintext getversion ``` | Optional. Boolean query parameter. When true, returns the version and build number of your Nok Nok deployment. |

## Response

The following attributes are always present in the JSON payload of the response.

| **Attribute** | **Description** |
| --- | --- |
| apiServer | API Server health check object |
| apiServer.version | Version of API Server, present only if request contains getversion=true |
| apiServer.statusCode | API Server status code |
| authServer | Auth Server health check object |
| authServer.version | Version of Auth Server, present only if request contains getversion=true |
| authServer.statusCode | Auth Server status code |

## Samples

### Sample request without optional parameter “getversion”

```plaintext
https://www.example.com:8443/nnlgateway/health
```

### Sample response without version information

```plaintext
{
    "apiServer": {
        "statusCode": 4000
    },
    "authServer": {
        "statusCode": 4000
    }
}
```

### Sample request with optional parameter “getversion”

```plaintext
https://www.example.com:8443/nnlgateway/health?getversion=true
```

### Sample response with version information

```plaintext
{
    "apiServer": {
        "version": "9.3.0.143-migrated-1.0.9",
        "statusCode": 4000
    },
    "authServer": {
        "version": "9.3.0-164",
        "statusCode": 4000
    }
}
```

## Response Status Codes

### API Server Status Codes

Status codes returned inside the "apiServer" object are described here.

| **Status Code** | **Description** |
| --- | --- |
| 4000 | The server is healthy |
| 5501 | Internal server error |
| 5503 | Database connection failed |
| 5601 | Error connecting to Authentication Server |
| 5700 | Current status is unknown |

### Auth Server Status Codes

Status codes inside the "authServer" object are described here.

| **Status Code** | **Description** |
| --- | --- |
| 4000 | The server is healthy |
| 4001 | At least one of the automatic jobs is disabled. This could be an expected result because you specifically disabled a job |
| 5501 | Internal server error |
| 5503 | Database connection failed |
| 5507 | The report generator job is not running |
| 5508 | The report data aggregator job is not running |
| 5509 | The transient data purge job is not running |
| 5510 | A JSP page cannot load due to a syntax error or problem with the Tomcat configuration |
| 5511 | Access denied to Tomcat directories/files at the root directory level only |
| 5512 | Access denied to one or more Tomcat subdirectories or one or more files in those subdirectories |
| 5513 | Unable to get the timezone offset of the database or server. Authentication or Admin Server only |
| 5514 | Unable to get the Nok Nok Smart Sense Service health check response |