Pages in Reference

noust probe

Probes of an address from outside the application, and the public status page.

Reference Updated 29 October 2026 View as Markdown

Shell

noust probe [OPTIONS] COMMAND [ARGS]...

Subcommands: history, list, remove, run, set, status-page

noust probe history

Show the incidents of a probe, newest first.

Shell

noust probe history [OPTIONS] NAME

Arguments: name

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--json`	Print the history as JSON.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe list

List the probes, where each stands and how often it answered.

Shell

noust probe list [OPTIONS]

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--json`	Print the probes as JSON.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe remove

Remove a probe with its answers, its days and its incidents.

Shell

noust probe remove [OPTIONS] NAME

Arguments: name

Option	What it does	Default
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe run

Ask a probe now (every one with no name), whatever its interval.

Shell

noust probe run [OPTIONS] [NAME]

Arguments: name

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--json`	Print the answers as JSON.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe set

Create a probe, or change the one of that name; what is not named is kept.

Shell

noust probe set [OPTIONS] NAME

Arguments: name

Option	What it does	Default
`--url`	What to ask: https://example.com/health.
`--method`	GET (default) or HEAD.
`--expect-status`	The statuses that mean well: 200-399 (default) or 200,204.
`--expect-text`	A word the page must contain (GET only, first 64 kB).
`--interval`	Seconds between two asks (default 60).
`--timeout`	Seconds an answer may take (default 10).
`--fail-after`	Bad answers in a row that make it down (default 3).
`--public`, `--private`	Show it on the status page.
`--title`	What the status page calls it.
`--enable`, `--disable`	Ask it, or stop asking.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe status-page

The public status page of the probes marked public.

Shell

noust probe status-page [OPTIONS] COMMAND [ARGS]...

Subcommands: publish, set, show, unpublish, write

noust probe status-page publish

Serve the page on a name of its own, over TLS, with a certificate.

Shell

noust probe status-page publish [OPTIONS] DOMAIN

Arguments: domain

Option	What it does	Default
`--skip-dns-check`	Do not require the name to resolve to this server (behind NAT).
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe status-page set

Change the status page's settings.

Shell

noust probe status-page set [OPTIONS]

Option	What it does	Default
`--enable`, `--disable`	Let the monitor write the page.
`--title`	What the page is called.
`--directory`	Where the files go (empty: /var/lib/noust/status-page).
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe status-page show

Show how the status page is set up and whether it is on a name.

Shell

noust probe status-page show [OPTIONS]

Option	What it does	Default
`-v`, `--verbose`	Show the detail of each step.
`--dry-run`	Rehearse without changing anything. Read-only checks still run.
`--no-color`	Never emit colour.
`--json`	Print the settings as JSON.
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe status-page unpublish

Take the page off its name, removing exactly what publishing made.

Shell

noust probe status-page unpublish [OPTIONS]

Option	What it does	Default
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust probe status-page write

Write the page's files now, instead of at the monitor's next scan.

Shell

noust probe status-page write [OPTIONS]

Option	What it does	Default
`--reason`	Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Something on this page is wrong or unclear? Report it on GitHub.

Help, contributing and the project’s policies are under Project.