Skip to content

Wp 7280 express docs #8004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
derranW26 wants to merge 1 commit into
base: master
Choose a base branch
from
+431 −0
Open

Wp 7280 express docs #8004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions modules/express/src/typedRoutes/api/common/ping.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ import { BitgoExpressError } from '../../schemas/error';
/**
* Ping
*
* Health check endpoint for BitGo Express. Use this endpoint to verify that the
* Express server is running and responsive before making other API calls.
*
* Common use cases:
* - Load balancer health checks
* - Container orchestration liveness probes (Kubernetes, ECS)
* - Monitoring and alerting systems
* - Pre-flight connectivity validation from client applications
*
* This endpoint requires no authentication and returns an empty 200 response
* when the service is operational.
*
* @operationId express.ping
* @tag express
*/
Expand Down
Loading