Binocs documentation

binocs check add

Add a new endpoint that you want to check


Add a check and start reporting on it. Check identifier is returned upon successful add operation.

This command is interactive and asks user for parameters that were not provided as flags.

binocs check add [flags]


  -n, --name string                        check name
  -p, --protocol string                    protocol (HTTP, HTTPS or TCP)
  -r, --resource string                    resource to check, a URL in case of HTTP(S), or HOSTNAME:PORT in case of TCP
  -m, --method string                      HTTP(S) method (GET, HEAD, POST, PUT, DELETE)
  -i, --interval int                       how often Binocs checks given resource, in seconds (default 60)
  -t, --target float                       response time that accommodates Apdex=1.0, in seconds with up to 3 decimal places (default 1.2)
      --region strings                     from where in the world Binocs checks given resource; choose one or more from: af-south-1, ap-east-1, ap-northeast-1, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1
      --up_codes 2xx                       what are the good ("up") HTTP(S) response codes, e.g. 2xx or `200-302`, or `200,301` (default "200-302")
      --up_confirmations_threshold int     how many subsequent "up" responses before triggering notifications (default 2)
      --down_confirmations_threshold int   how many subsequent "down" responses before triggering notifications (default 2)
      --attach strings                     channels to attach to this check (optional); can be either "all", or one or more channel identifiers
  -h, --help                               help for add

Options inherited from parent commands

      --config string   config file (default is $HOME/.binocs/config.json)
  -q, --quiet           enable quiet mode (hide spinners and progress bars)
  -v, --verbose         verbose output