CH·02CLI reference

deeprelay alerts get

Show the org's alert settings

Show the org's alert settings

Synopsis

Shows your organization's alert settings: the low-balance threshold in dollars, whether each of the four alert emails is on or off, and when the settings were last saved (never (defaults) until someone saves them). The note under the table is a reminder that a member always receives their own limit emails.

Any member of the organization can run it. It exits 0 on success and 1 on any error.

The table rows:

RowMeaning
Balance thresholdThe low-balance email fires when the balance drops below this
Low balanceLow-balance emails to org admins
Plan allowanceEmails at 80% and 100% of a plan allowance
Key budgetsEmails at 80% and 100% of a key's monthly budget
Member spendEmails to org admins at 80%, 95% and 100% of a member's limit
UpdatedWhen the settings were last saved

With -o json the API object is printed as is: balance_threshold_cents, email (balance_low, subscription_quota, api_key_budget, member_spend), updated_at (null until the first save) and note.

Examples

deeprelay alerts get

# The threshold in cents, for a script
deeprelay alerts get -o json | jq '.balance_threshold_cents'
deeprelay alerts get [flags]

Options

  -h, --help   help for get

Options inherited from parent commands

      --api-base string   API base URL (override with DEEPRELAY_API_BASE env) (default "https://api.deeprelay.ai/v1")
      --debug             Enable debug logging to stderr
      --no-preflight      Skip the plan/credit check before inference requests (override with DEEPRELAY_NO_PREFLIGHT env)
  -o, --output string     Output format: table|json (default table on TTY, json otherwise) (default "table")

SEE ALSO

← The deeprelay CLI