Reference

Ping API

A monitored job has a unique URL on your server. Find it on the job detail page after creating a monitored job.

Endpoints

Replace TOKEN with the token in the job’s ping URL.

The route accepts numeric outcome segments of one to three digits. 0 means success; a nonzero code means failure.

GET, HEAD, and POST are accepted. A HEAD request is a report too: do not use it as a harmless availability probe for this URL. Use the server’s /up endpoint to check server readiness instead.

Send output with a report

Use POST to attach a command’s output:

curl -fsS -m 10 --retry 5 -o /dev/null -X POST \
  --data-binary @backup.log \
  "https://jobs.example/ping/TOKEN/0"

Replace 0 with the actual result. Output retention and size limits apply. Keep credentials out of the body.

Responses

A recognized token receives a plain-text OK response after processing. An unknown token returns HTTP 404 rather than pretending to record the report.

Responses use Cache-Control: no-store. Configure reverse proxies to let each report reach the server; serving a cached response would hide missing telemetry.

Token security

A ping URL is a credential. It permits submitting reports, not reading job details. Keep tokens out of public repositories, screenshots, and shared logs.

If a token is exposed, regenerate the ping URL in the job’s interface and update the reporting script. The old URL should no longer be used.

Reporting does not execute work

These endpoints record what external work reports. They do not start the underlying command. For execution managed by Oh My Job, use a command job with an enrolled agent.