OpenCatapult Docs
HomeCommunity
Search…
1.0.0
Introduction
Home
Introduction
Concept
Quick Start
About this doc
Guides
User Guide
Developer Guide
References
CLI
API
Account
Catapult Engine
External Service
External Service Type
Health
Job Definition
Job Queue
Project
Project Data Model
Project Member
Provider
Token
Version
Engine
Web UI
Mobile
Task Providers
Management
Roadmap
Powered By GitBook
Health
These endpoints are used to check whether the API is working normally.

Check Health

Method: HEAD
Uri: /Health
Authorization: Anonymous
Check whether the engine API is healthy

Check Health (GET)

Method: GET
Uri: /Health
Authorization: Anonymous
Check whether the engine API is healthy using GET method (For client that does not support HEAD)

Check Health Secured

Method: HEAD
Uri: /Health/Secure
Authorization: Authenticated
Check whether the engine API is healthy when invoked by authenticated user

Check Health Secured (GET)

Method: GET
Uri: /Health/Secure
Authorization: Authenticated
Check whether the engine API is healthy when invoked by authenticated user using GET method (For client that does not support HEAD)
Previous
External Service Type
Next
Job Definition
Last modified 3yr ago
Copy link
Contents
Check Health
Check Health (GET)
Check Health Secured
Check Health Secured (GET)