health

Health check status.

Returns health status as OK (with http statusCode 200) when application is running and healthy.

get/api/v1/health

Response

Successful Response

statusCodeinteger required

Status http code.

status'OK' | 'ERROR' | 'NOT_FOUND' | 'EXISTS_MUST_BE_UNIQUE' | 'FAILED_TO_CREATE_OR_UPDATE' | 'SUCCESSFULLY_DELETED' | 'CONFLICT_NEWER_REVISION_IN_DB' | 'FORBIDDEN' | 'USER_VERIFIED' | 'USER_VERIFICATION_FAILED' | 'USER_LOGGED_OUT' | 'OWNER_ASSIGNED_TO_CATALOGUE' | 'INVALID_VAT_CODES' | 'INTERNAL_SERVER_ERROR' | 'DOCUMENT_UNIQUE_ORDER' | 'ONLY_ONE_ENV_THROTTLING' | 'PARENT_ITEM_EXISTS' | 'INVALID_JSON' | 'DOCUMENT_ASSIGNED' | 'DOCUMENT_ALREADY_ASSIGNED_TO_PAGE' required

Statuses.

Changes

No recorded changes to this endpoint across all 1 revision of this API.