Is Alive health check

Description

This service is a health check used to confirm if the server is up and running.

Before rendering dynamic content like login or registration links, a client application should call this endpoint. If the server does not respond with a 200 OK, the application should fall back to displaying static content and hide functionality related to Thalamus.

---

Request

Endpoint

This service may be available at a versioned or unversioned endpoint:

GET https://<server-url>/api/isAlive
GET https://<server-url>/api/v4/isAlive

Parameters

The following parameters may be used with the versioned (/v4) endpoint.

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.
token	Query / Header	The authentication token for the API. Use Thalamus-Token for the header.
activity	Query / Header	Optional. The activity to be used. Use Thalamus-Activity for the header.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.

Full URL Example

https://<server-url>/api/v4/isAlive

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

Indicates that the server is up and running. The isAlive field will have a value of 1.

Field	Type	Description
isAlive	String	A value of "1" confirms the server is alive.
context	Object	The standard context object.

JSON

{
  "context": {
    "links": [],
    "activities": [],
    "simpleProfile": null
  },
  "isAlive": "1"
}

⚠️ No Response or Non-200 Status

If the server returns any status other than 200 OK, or if the request times out (e.g., after one minute), the client application should assume the server is down. In this scenario, all dynamic functionality related to Thalamus should be hidden from the user.