Run one check once, anonymously

POST 
/api/v1/tools/run

Runs an http (GET), ssl, dns or tcp check once against a public target and returns the normalised result. Nothing is stored. Disabled (404) unless SP_TOOLS_ENABLED=true (system parameter tools.enabled). Every run goes through an egress guard that refuses private, loopback, link-local and reserved addresses, whatever SP_EGRESS_ALLOW_PRIVATE says, as well as the instance's own hosts. Limits: 10 runs a minute and 100 a day per client IP, 16 runs in flight server-wide, 10 s per run, 5 redirects for http. A result is cached 60 s per (type, target, options). Error codes: INVALID_TARGET (400), TARGET_NOT_ALLOWED (403), RESOLVE_FAILED (422), RATE_LIMITED (429), SERVICE_BUSY (503, with Retry-After), TIMEOUT (504).

Request

Responses

200

The run's result

400

Invalid JSON body or target (VALIDATION_ERROR, INVALID_TARGET)

403

The target is not allowed (TARGET_NOT_ALLOWED)

404

Resource not found

422

The target name could not be resolved (RESOLVE_FAILED)

429

Per-IP limit reached (RATE_LIMITED)

503

Too many runs in flight (SERVICE_BUSY)

504

The target did not answer in time (TIMEOUT)