System

Application system related endpoint

Liveness health check

get

/api/system/health/liveness

Checks that the application is live and works as expected

Liveness check

A simple query to the fabric database is executed to determine if the app is live.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses

200

OK

application/json

Description of the api's health status

statusinteger · enumOptional

The status of the health check

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get/api/system/health/liveness

GET /api/system/health/liveness HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "status": 1
}

Readiness health check

get

/api/system/health/readiness

Checks that the application is live and can accept traffic.

Readiness check

The readiness status of the application is determined by a moving average of the response time of the most recent requests served. If it exceeds a max acceptable value then the application is considered unready.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses

200

OK

application/json

Description of the api's health status

statusinteger · enumOptional

The status of the health check

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get/api/system/health/readiness

GET /api/system/health/readiness HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "status": 1
}

Startup health check

get

/api/system/health/startup

Checks that the application has finished booting up and can be considered live.

Startup check

A simple query to the fabric database is executed to determine if the app is running.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses

200

OK

application/json

Description of the api's health status

statusinteger · enumOptional

The status of the health check

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

413

Request Entity Too Large

application/json

422

Unprocessable Entity

application/json

425

Too Early

application/json

500

Internal Server Error

application/json

get/api/system/health/startup

GET /api/system/health/startup HTTP/1.1
Host: api.vaix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
x-vaix-client-id: text
Accept: */*

{
  "status": 1
}