Request an invite

Probe agents

The probe agent runs your checks from your own servers: ping, TLS certificates, DNS through your own resolver, and checks inside private networks. The paid plan includes 1 agent; each agent includes 25 monitors.

You need the paid plan and a host that can reach what you want to check. The free plan has no agents.

Each further agent is €2 a month. See plans

Guides and contents

Register the agent

  1. Go to Probes → Register probe.
  2. Enter a Name and a Region such as eu-west, and keep the Kind on Agent. Provider, ASN and location are optional; Public shows the probe as a region on your page’s Edge Network tab.
  3. Copy the token. It’s shown once, and only its hash is stored; you can rotate it later.

Get the agent

There’s no public download of the agent yet. Email support@upstreamr.com with your organization’s name and we’ll send you the agent and its install guide for your platform.

Configure it and try it

The agent reads its API address and token from two environment variables, a token file or a YAML or JSON configuration file. It never takes the token as a command-line flag.

STATUS_API_URL=https://app.upstreamr.com/api
STATUS_PROBE_TOKEN=prb_…

# Fetch this agent's monitors, run each once, print the results, submit nothing
status-probe --once

Once it runs, the agent fetches its monitors once a minute: add, change or remove a monitor and it follows without a restart.

Give it monitors

In the monitor dialog, Probes picks the agents that run a monitor; with none ticked, every enabled probe runs it. With two or more probes, Quorum sets how many must agree before the monitor goes down, so one probe’s bad network doesn’t mark your service down.

Automate it

Register probes, rotate their tokens and assign monitors over the management API, with an API key scoped probes:write or monitors:write. The probe’s token comes back once, in the response.

# Register a probe with an API key that has the probes:write scope
curl -X POST https://app.upstreamr.com/api/v1/admin/probes \
  -H "Authorization: Bearer sk_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Frankfurt 1","region":"eu-central","asn":64500}'

{"data":{"id":"prb_…","token":"prb_…"}}

# On the probe host, the agent’s environment
STATUS_API_URL=https://app.upstreamr.com/api
STATUS_PROBE_TOKEN=prb_…

More on this for network operators: Automate your probes. Every endpoint is in the API reference ↗.