1. CLI
  2. Commands

CLI

Commands

onlineornot offers a number of commands to manage your OnlineOrNot account.

  • docs - Open this page in your browser
  • checks - Manage your OnlineOrNot uptime checks
  • billing - Open the billing settings in your browser
  • login - Create your API token to use this CLI
  • whoami - Retrieve your user information and test your authentication configuration

docs

Open the OnlineOrNot documentation in your default browser.

onlineornot docs

checks

Manage your OnlineOrNot uptime checks

create

Creates a new uptime check, with a default test interval of 5 minutes

onlineornot checks create <NAME> <URL> [OPTIONS]
  • NAME string, required
    • The name of your new uptime check
  • URL string (url), required
    • The url to check
  • --json boolean, optional
    • Return the result of the command as JSON

list

List your uptime checks

onlineornot checks list [OPTIONS]
  • --json boolean, optional
    • Return the result of the command as JSON

view

View a specific uptime check

onlineornot checks view <ID> [OPTIONS]
  • ID string, required
    • The ID of the check you wish to view
  • --json boolean, optional
    • Return the result of the command as JSON

delete

Delete a specific uptime check

onlineornot checks delete <ID>
  • ID string, required
    • The ID of the check you wish to delete

billing

Open the OnlineOrNot billing settings in your default browser.

onlineornot billing

login

Open the OnlineOrNot Developer portal in your default browser.

This takes you to a page where you can create an API token, which you need to be able to interact with onlineornot.

onlineornot login

whoami

Retrieve your user information, and test your authentication/authorization configuration.

onlineornot whoami

© 2024 OnlineOrNot SASU, 66 Av. des Champs-Élysées 75008 Paris
Made with in Sydney, Australia 🇦🇺 and Toulouse, France 🇫🇷