ApiHealthz CLI Documentation

ApiHealthz CLI lets you monitor API uptime and health directly from your terminal.
No SDKs. No agents. No dependencies added to your stack.

open_in_new View on npm

No Installation needed


                    $ npx apihealthz add

Authentication

ApiHealthz uses secure device-based OAuth login (no passwords).

Login


                        $ npx apihealthz auth
                        login --provider=google

You can specify the provider or you can ignore the option. More auth providers are under plan.

The CLI will show a URL and a one-time code:


                    Copy this code:
                    NGT-RCH-KTSD

                    Press enter to continue setting up in browser...

Once approved, the CLI will automatically log you in.

Check Auth Status


                        $ npx apihealthz auth
                        status

Example output:


                    Logged in as
                    tom@gmail.com

Logout


                        $ npx apihealthz auth
                        logout

This clears the local auth token.

Adding a Site / API to Monitor

Add a new URL


                      $ npx apihealthz add

Listing All Monitors


                    $ npx apihealthz list

Deleting a Monitor


                    $ npx apihealthz delete

Design Philosophy

• CLI-first
• Zero runtime dependencies
• OAuth-based authentication
• No agents or SDKs
• Works from local machines, servers, and CI

Example Workflow (Quick Start)


                    $ npx apihealthz auth
                    login

                    $ npx apihealthz add

                    $ npx apihealthz list

You're live in under a minute.

terminal

Ready to get started?

Start monitoring your APIs in under a minute.

Back to Home