UDP port check Beta
POST /api/v1/monitors
Type udp: send a datagram and wait for a reply. Nothing acknowledges a datagram, so a reply is the only proof that anything is there.
There is no separate endpoint for this: it is the ordinary create a monitor call with type set to "udp". The same settings apply when you update a monitor with PATCH /api/v1/monitors/{id}.
Every type shares the same interval, retries, alerting, maintenance, results and reports. Only the settings below differ. See Check types for how the nine types compare.
Up or down
- The check is up only when something replies in time. Silence is down: No reply within 10s.
- With
expectString, the reply must also contain that text. - Because anything listening can answer, set
sendStringandexpectStringto something the real service would answer. That is what makes a UDP check meaningful. - With no
sendString, a newline is sent.
Settings that apply
| Setting | Notes |
|---|---|
url required | The host to send to. Not a URL. |
port required | 1 to 65535. This type has no standard port. |
sendString | The datagram to send. Up to 500 characters. \r, \n and \t are sent as real characters. |
expectString | The reply must contain this. Up to 500 characters. |
timeoutSeconds | How long to wait for a reply. |
Create one
Related
- TCP port check: for services that accept connections
- Ping check: is the host there at all