https://docs.tenpmuptime.com/docs/reference/Recent content in Reference on Tenpm Uptime DocsHugoen-ushttps://docs.tenpmuptime.com/docs/reference/api/Mon, 01 Jan 0001 00:00:00 +0000https://docs.tenpmuptime.com/docs/reference/api/<h1 id="api-reference">API reference<a class="anchor" href="#api-reference">#</a></h1> <p>The JSON API a <code>monitor</code> agent uses to enroll with a <code>tenpm uptime</code> server, sync its assigned check set, and report results and status back. Generated from <code>docs-site/assets/tenpmuptime-monitor.yaml</code> — see that file&rsquo;s header for how it&rsquo;s kept in sync with the code.</p> <a href="https://docs.tenpmuptime.com/tenpmuptime-monitor.yaml" download class="book-btn">Download the raw OpenAPI spec (tenpmuptime-monitor.yaml)</a> <p>The JSON API a <code>monitor</code> agent uses to enroll with a <code>tenpm uptime</code> server, sync its assigned check set, and report results and status back. This is the wire contract described in <code>internal/model</code> and implemented by <code>internal/server/api_handlers.go</code>; both binaries build against the same Go structs today, so treat this document as generated-by-hand from that code, not the other way around — if the two disagree, the code is right and this file is stale. Every route except <code>POST /api/enroll</code> requires the monitor's own API key, minted at enrollment. <code>POST /api/enroll</code> requires an <em>enrollment token</em> instead (an org token or a platform token — see the security scheme below), since no monitor exists yet at that point. Error responses across every endpoint are a <strong>plain-text body</strong> (one line) with a non-2xx status, not a JSON envelope — the handlers use Go's <code>http.Error</code>. The <code>4xx</code>/<code>5xx</code> responses below document status code and body meaning; there is no shared error schema.</p>