Domains

Set the port check

Name the TCP ports that must accept a connection — SSH, a database, a mail server, a game server — on the website's own hostname or on another host such as its origin, and every 5 minutes each one gets a connect and an immediate close from Cloudflare's network. Nothing is sent, so it proves a listener is there, not that the service behind it works. A closed or filtered port is confirmed by a second probe before any rule fires. A host that resolves to Cloudflare's edge is reported as unprobeable rather than closed, since the edge exposes no raw TCP ports; port 25 is refused because Cloudflare blocks outbound SMTP. Replaces any previous setting and probes immediately. If the organization has no alert rule for port checks yet, an email rule is created so failures reach the key's creator.

put/v1/domains/{id}/port

Request

  • Base URL: https://api.upcheck.so
  • URL: https://api.upcheck.so/v1/domains/{id}/port
  • Auth: HTTP bearer

Path parameters

idstring required
Example:9b1d...

Opaque identifier.

Request body

hoststring

Host to connect to. Empty means the website's own hostname. A website served through Cloudflare needs its origin's hostname or IP here, because the edge exposes no raw TCP ports to probe.

portsinteger[] required

TCP ports that must accept a connection. Up to 10; each is its own connect on every probe.

enabledboolean

Pause the check without forgetting its settings.

Example request

{
  "host": "db.example.com",
  "ports": [
    22,
    443,
    5432
  ]
}

Response

The port monitor after the first probe.

idstring required

Opaque identifier.

organizationIdstring required

Opaque identifier.

domainIdstring required

Opaque identifier.

subject'http' | 'certificate' | 'dns' | 'registration' | 'keyword' | 'content' | 'port' required

Which check a monitor, rule or history row is about.

enabledboolean required

Whether the scheduler runs it. The keyword, content and port checks are disabled until they have a config.

intervalMsnumber required
nextChecknumber required

Unix ms.

lastCheckednumber required
status'checking' | 'ok' | 'warn' | 'crit' | 'unknown' required
summarystring required
detailunknown required
lastErrorstring nullable required
consecutiveFailuresnumber required
failingSincenumber nullable required

Example response

{
  "id": "9b1d...",
  "organizationId": "9b1d...",
  "domainId": "9b1d..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.