hookpulse

Saved environments owned by the current account or guest; empty without a session.

{
  "type": "object",
  "properties": {}
}

Register a device UUID before discovery and collector selection. Registers one device (maximum 25 per owner), creating a guest if needed. The UUID is the one-hour discovery capability; it is not a telemetry credential. Choose passos.posix or passos.powershell for the TARGET terminal. The checks only display allowlisted system facts and install nothing.

{
  "type": "object",
  "properties": {
    "nome": {
      "type": "string",
      "description": "Device name, 1–60 characters."
    },
    "grupo": {
      "type": "string",
      "description": "Optional group, up to 40 characters."
    },
    "request_id": {
      "type": "string",
      "format": "uuid",
      "description": "Optional UUID v4 generated once per registration. Becomes the device id. Retry with the same id/name/group returns the owned environment instead of duplicating a late write; conflicting input is refused."
    }
  },
  "required": [
    "nome"
  ]
}

Read the detected environment and compatible measurements.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    }
  },
  "required": [
    "id"
  ]
}

Create or rotate an authenticated collector channel for this device. Ownership is checked before the app asks the input central. The server chooses the channel id and authenticates batches only against a hash of the collector credential. The whole setup this call returns — credential included — is also saved, encrypted with a key only the input central holds and bound to that credential, so the owner can read it again with GET /api/ambientes/:id/inputs/:collector/setup. The credential does not expire: a device that stays off for weeks reconnects with it. It stops working only when a new configuration rotates it or the channel is removed. A repeated call for the same collector rotates the credential, replaces the saved setup and replaces `monitoring` with the list sent — that is how the monitored scope is edited — so the configuration on the device stops authenticating until it is replaced; a paused channel stays paused. DNS selects the receiver; it never authenticates the device.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "collector": {
      "type": "string",
      "enum": [
        "alloy",
        "telegraf",
        "opentelemetry",
        "ncpa",
        "collectd",
        "snmp"
      ],
      "description": "alloy, telegraf, opentelemetry, ncpa, collectd or snmp."
    },
    "monitoring": {
      "type": "array",
      "minItems": 1,
      "maxItems": 5,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "system",
          "host",
          "disk",
          "network",
          "mysql",
          "asterisk"
        ]
      },
      "description": "One or more of system (the whole machine), host (CPU, memory, load and uptime), disk, network, mysql and asterisk. `system` already includes host, disk and network, and those three together are stored as `system`. Items the collector cannot collect (see `collects` on the channel) are not measured."
    }
  },
  "required": [
    "id",
    "collector",
    "monitoring"
  ]
}

List this device's collector channels, their state and their live numbers.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    }
  },
  "required": [
    "id"
  ]
}

The saved setup of one collector channel: the configuration in use, its files and steps. Returns the setup generated last for this channel — the one whose credential is accepted now — exactly as POST /api/ambientes/:id/inputs returned it, so the files can be copied or installed again without rotating the credential. It carries the credential: only the device owner gets it, one channel per request, never cached; list routes never include it. 404 `setup_not_saved` when the channel was generated before setups were saved, or was removed; 409 `setup_unreadable` when the input central can no longer open it. In both cases generate a new setup with POST /api/ambientes/:id/inputs.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "collector": {
      "type": "string",
      "enum": [
        "alloy",
        "telegraf",
        "opentelemetry",
        "ncpa",
        "collectd",
        "snmp"
      ],
      "description": "alloy, telegraf, opentelemetry, ncpa, collectd or snmp."
    }
  },
  "required": [
    "id",
    "collector"
  ]
}

The batches this collector sent, newest first — filtered and paginated on the server. Every batch the input central received for this channel, as it arrived: when, the protocol, the result (`stored`; `rejected` by the receiver, with the reason; or `discarded` while the channel was paused, when its data is not kept), the answer given to the collector, the size, and how many series and samples it carried. The central keeps the newest batches of each channel up to the limits in `limits` (count, bytes and days); older ones leave as new ones arrive, and removing the channel deletes them. `q` searches metric names — host and service names for NCPA — by opening the batches newest first within a time budget: `search.complete` says whether all candidates were read, and repeating the call continues faster. Open one batch with GET /api/ambientes/:id/inputs/:collector/history/:batch.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "collector": {
      "type": "string",
      "enum": [
        "alloy",
        "telegraf",
        "opentelemetry",
        "ncpa",
        "collectd",
        "snmp"
      ],
      "description": "alloy, telegraf, opentelemetry, ncpa, collectd or snmp."
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "description": "Page, from 1 (newest). Beyond the last page answers the last one.",
      "default": 1
    },
    "size": {
      "type": "integer",
      "enum": [
        10,
        25,
        50,
        100
      ],
      "description": "Batches per page: 10, 25, 50 or 100.",
      "default": 25
    },
    "outcome": {
      "type": "string",
      "enum": [
        "stored",
        "rejected",
        "discarded"
      ],
      "description": "Only batches with this result."
    },
    "since": {
      "type": "string",
      "format": "date-time",
      "description": "Only batches received at or after this instant (ISO 8601)."
    },
    "until": {
      "type": "string",
      "format": "date-time",
      "description": "Only batches received at or before this instant (ISO 8601)."
    },
    "q": {
      "type": "string",
      "maxLength": 120,
      "description": "Metric name (or NCPA host/service) contains this text; up to 120 characters."
    }
  },
  "required": [
    "id",
    "collector"
  ]
}

One received batch, decoded: its series with labels and values, or its NCPA checks. Remote Write (1.0 and 2.0), OTLP (protobuf or JSON) and NRDP become the same shape: `series` (`name`, `labels`, `points` as `[milliseconds, value]`, and `type`/`unit`/`help` when the collector sent them; OTLP points also carry `resource`, an index into `resources`) or `checks` for NCPA (`host`, `service`, `state` 0–3, `output`, `perfdata`). A value JSON cannot hold comes as a string: `"NaN"`, `"+Inf"`, `"-Inf"` or `"stale"`. Very large batches keep the first 5,000 series (`truncated`). `newer`/`older` are the neighbouring batch ids, for moving through the history.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "collector": {
      "type": "string",
      "enum": [
        "alloy",
        "telegraf",
        "opentelemetry",
        "ncpa",
        "collectd",
        "snmp"
      ],
      "description": "alloy, telegraf, opentelemetry, ncpa, collectd or snmp."
    },
    "batch": {
      "type": "string",
      "description": "The batch `id` from the history list.",
      "enum": [
        "1790165043059-0005-s-204-w-5357"
      ]
    }
  },
  "required": [
    "id",
    "collector",
    "batch"
  ]
}

Revokes and removes one collector channel from a device. The input central removes only a channel of the same owner. This stops new authenticated input and removes the channel from the device list — also for a channel whose device was already deleted. It does not uninstall or stop the collector on the device (`uninstall.remove` in GET /api/ambientes/:id/inputs is the command for that), and stored measurements remain subject to their retention policy.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "collector": {
      "type": "string",
      "enum": [
        "alloy",
        "telegraf",
        "opentelemetry",
        "ncpa",
        "collectd",
        "snmp"
      ],
      "description": "alloy, telegraf, opentelemetry, ncpa, collectd or snmp."
    }
  },
  "required": [
    "id",
    "collector"
  ]
}

Pauses or resumes one collector channel. Pausing keeps the channel, its credential and its configuration: batches the collector sends while paused are accepted and discarded, so nothing is stored or measured and the collector does not retry in a loop. Resuming stores the next batch again. The input central changes only a channel of the same owner, including one whose device was already deleted.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "collector": {
      "type": "string",
      "enum": [
        "alloy",
        "telegraf",
        "opentelemetry",
        "ncpa",
        "collectd",
        "snmp"
      ],
      "description": "alloy, telegraf, opentelemetry, ncpa, collectd or snmp."
    },
    "active": {
      "type": "boolean",
      "description": "false pauses, true resumes."
    }
  },
  "required": [
    "id",
    "collector",
    "active"
  ]
}

Every collector channel of the caller, with state and live numbers, in one response. One call for the whole fleet — one query to the time-series store for all channels, never one per device. It is the same function the dashboard subscribes to over the socket (`/api/inputs/serie`), where the input central then pushes `inputs.updated` and `inputs.removed` events; integrators get the same data here without the socket.

{
  "type": "object",
  "properties": {}
}

Preview or save the allowlisted discovery report for one device. Send terminal and saidas (step id to pasted output), initially with conferir:true. Preview returns normalized dados, additional passos and pronto without writing. Omit conferir to save when complete. Only allowlisted facts are saved, never raw commands. First report wins within one hour; identical retries do not rewrite. The discovery never creates a legacy measurement, sends a reading, installs software or creates a schedule. With Accept: text/plain the receipt is only `ok`.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "relatorio": {
      "type": "string",
      "maxLength": 8192,
      "description": "Alternative legacy key=value report. Do not combine with saidas."
    },
    "terminal": {
      "type": "string",
      "enum": [
        "posix",
        "powershell"
      ],
      "description": "posix or powershell; required with saidas."
    },
    "conferir": {
      "type": "boolean",
      "description": "true previews without saving. Omit or use false to save a complete report."
    },
    "saidas": {
      "type": "object",
      "maxProperties": 10,
      "additionalProperties": {
        "type": "string",
        "maxLength": 4096
      },
      "description": "Step id to pasted output; up to 10 entries, 4096 characters each, 8192 UTF-8 bytes total request."
    }
  },
  "required": [
    "id"
  ]
}

Lists your measurements with commands adapted to each saved device environment. Two views of the same thing: `coletas` is one entry per measurement, `equipamentos` is one per machine with a SINGLE command that does all of its measurements and a SINGLE cron line. Use the device one unless you really want a single measurement on its own. Commands are generated only from a detected environment. Legacy collections without one keep their readings, but comandos.agora/agenda are null until a compatible environment is provided. Curl, wget and Python 3 follow the detected capabilities; Windows disk uses PowerShell. comandos.agora is a readable multiline block; run the whole block together. A separate cron line is offered only when crontab exists. Unsupported formats are never guessed.

{
  "type": "object",
  "properties": {}
}

Adds compatible measurements to a previously detected device. First create /api/ambientes and submit its environment report. Reference that ambiente_id here; its saved name and group are authoritative. Same device+measurement returns the existing stream instead of duplicating it. A profile adds only compatible measurements. Up to 200 collections per owner. The signed collection id writes only its own measurement stream.

{
  "type": "object",
  "properties": {
    "nome": {
      "type": "string",
      "description": "Device name, up to 60 characters."
    },
    "grupo": {
      "type": "string",
      "description": "Optional group, up to 40 characters."
    },
    "ambiente_id": {
      "type": "string",
      "description": "UUID of a detected environment owned by this account/guest."
    },
    "medida": {
      "type": "string",
      "description": "Which measurement; defaults to `loadavg`."
    },
    "perfil": {
      "type": "string",
      "enum": [
        "essentials",
        "completo"
      ],
      "description": "essentials or completo. Expands to compatible measurements and takes precedence over medida."
    }
  },
  "required": [
    "nome",
    "ambiente_id"
  ]
}

The latest readings of one device, for the screen that draws it. Authorised by YOUR session, never by the symbol in the crontab. A device that is not yours answers 404 exactly like one that does not exist — telling the two apart would confirm to a stranger that the id exists — 401 is only for sending no credential at all, which tells the caller what they already know. When the ingest origin cannot be read the answer is 503, not an empty series: a screen must say "I could not read now", never let you believe your machine stopped. Readings are reused for up to 60 seconds. Poll no faster than once per minute in steady use; `poll_after_sec` is the minimum wait for this response. During the first minute after registration an empty series may be checked every 5 seconds. Do not overlap requests. On 429 or 503, respect `Retry-After` and `retry_after_sec`, increase the delay after repeated failures, and keep the last successful reading. Changing n does not bypass reuse or capacity limits.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The signed 22-character collection symbol, or a legacy UUID v4.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "n": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "description": "How many readings, newest first. Default 60, maximum 500."
    }
  },
  "required": [
    "id"
  ]
}

Renames one measurement, or stops and resumes reading it. The id never changes: it is the write symbol already sitting in a crontab, and renaming on a screen must not send anyone back to the machine to edit a line. Send only what you are changing; anything omitted stays as it is. `ativa:false` takes the measurement out of the fleet read — it keeps its history and its commands, stops costing a query, and comes back with `ativa:true`. It does NOT silence the machine: the symbol is signed and stands on its own at the ingest origin, so a device keeps sending until you remove its cron line. The answer is the collection as it now stands — draw the screen from it, not from a local copy.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The signed 22-character collection symbol, or a legacy UUID v4.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "nome": {
      "type": "string",
      "description": "New name, 1–60 characters."
    },
    "grupo": {
      "type": "string",
      "description": "New group, up to 40 characters; empty clears it."
    },
    "ativa": {
      "type": "boolean",
      "description": "false stops reading this measurement; true resumes it."
    }
  },
  "required": [
    "id"
  ]
}

Removes one measurement and frees that slot on the device. What disappears is the OWNERSHIP: your list, the authority to read that series, and the unique slot that measurement holds on that environment — so you can add it again later. Readings already stored at the ingest origin stay there until their own retention. The machine keeps sending: the symbol is signed and stands on its own there, which is why the answer carries `remover`, the command that takes the line out of the crontab. Use `ativa:false` instead when you only want to stop looking.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The signed 22-character collection symbol, or a legacy UUID v4.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    }
  },
  "required": [
    "id"
  ]
}

Renames a device, and its measurements along with it. One machine has one name. The measurements carry a copy of it, so renaming here renames them too — leaving the old name on them would show the same machine twice in a list that groups by device. Its collector channels take the new name and group too in `GET /api/coletas` (`inputs[]`), and the group decides which dashboard tab the device is under. Send only what changes; what you omit stays. The detected environment is never rewritten: it is evidence of what that machine reported.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    },
    "nome": {
      "type": "string",
      "description": "New device name, 1–60 characters."
    },
    "grupo": {
      "type": "string",
      "description": "New group, up to 40 characters; empty clears it."
    }
  },
  "required": [
    "id"
  ]
}

Removes a device and every measurement on it, in one call. One call, not one per measurement — the same reason `GET /api/coletas/serie` exists. What goes away is the ownership: your list, the authority to read those series, and the slots those measurements held, so the device can be registered again. Readings already stored at the ingest origin stay there until their own retention, and the machine keeps sending: the symbols are signed and stand on their own there. That is why the answer carries `remover`, one command per measurement that had a cron line. The device's collector channels are revoked first; if the input central cannot confirm that, nothing is deleted (503) and the call can be repeated, so no channel is left receiving data without a device.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Device environment UUID v4; the report URL is a one-hour write capability.",
      "enum": [
        "3f2504e0-4f89-41d3-9a0c-0305e82c3301"
      ]
    }
  },
  "required": [
    "id"
  ]
}

Full index of the HookPulse API.

{
  "type": "object",
  "properties": {}
}

Liveness.

{
  "type": "object",
  "properties": {}
}

Creates a guest token hp_… Keep the token: without it there is no way back to the monitors, unless you have already tied them to an e-mail.

{
  "type": "object",
  "properties": {}
}

Lists the guest's/session's endpoints.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    }
  },
  "required": [
    "guest_token"
  ]
}

Creates a dead-man endpoint. Use cron+tz+grace_sec for a real schedule (mutually exclusive with interval_sec) or interval_sec for plain silence detection. max_duration_sec alerts when a run opened by /in/:id/start hangs. May return 402 x402 when it leaves the free tier. This response is the only one that shows the monitor's `token` and the `templates` — keep them. The second monitor, or an interval below the free minimum, answers **402 with `accepts[]`**: pay and repeat. A miss alerts at most once per 24h — or per `alert_repeat_sec`, or per interval, whichever is longer. Send `cron`+`tz`+`grace_sec` instead of `interval_sec` for a real schedule: a 03:00 backup is late at 03:01:30, not 24 hours later. `max_duration_sec` catches the other failure: a run that starts and hangs, which plain silence detection only notices at the next scheduled time.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "how you will recognise the routine in an alert; required, trimmed, max 80 chars, punctuation alone is rejected"
    },
    "interval_sec": {
      "type": "number",
      "description": "Tolerated silence, in seconds. Below the free minimum, it costs."
    },
    "cron": {
      "type": "string",
      "description": "five-field cron, e.g. 0 3 * * *"
    },
    "paused_until": {
      "type": "string",
      "description": "maintenance window end (UTC ISO), max 30 days ahead"
    },
    "tz": {
      "type": "string",
      "description": "IANA time zone for cron, default UTC"
    },
    "grace_sec": {
      "type": "number",
      "description": "tolerance after the scheduled time, default 90, min 30"
    },
    "max_duration_sec": {
      "type": "number",
      "description": "ceiling for an open run in seconds, 60..86400; null or 0 turns it off"
    },
    "alert_repeat_sec": {
      "type": "number",
      "description": "gap before the same incident alerts again, 3600..2592000; null keeps the 86400 default"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "up to 8 tags to group the monitor; lower-cased, [a-z0-9._-], max 32 chars each"
    },
    "alert_to": {
      "type": "string",
      "description": "E-mail to alert on a miss; without it, the account is alerted."
    },
    "alert_url": {
      "type": "string",
      "description": "Public HTTPS URL that receives a POST on a miss (Slack Incoming, Discord, n8n)."
    }
  },
  "required": [
    "guest_token",
    "name"
  ]
}

Reads a crontab and proposes one monitor per scheduled line. Without apply=1 nothing is written; the proposal says what was ignored and why. Passwords in the command are redacted. The body is the crontab itself, as `text/plain`. Without `?apply=1` **nothing is written**: you get the proposal — what would become a monitor, what was ignored and why, and what still fits in the free tier. With `apply=1` it is all or nothing, under the same rules as `POST /api/endpoints`. Comments, variables and `@reboot` are ignored (there is no way to know when to expect a reboot); `@daily` and friends become the equivalent expression. The command becomes the monitor name, with passwords and tokens redacted first — the name travels in the alert e-mail, in the public dashboard and in the badge.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "crontab": {
      "type": "string",
      "description": "the crontab text"
    },
    "apply": {
      "type": "string",
      "description": "\"1\" to create the monitors"
    }
  },
  "required": [
    "guest_token",
    "crontab"
  ]
}

Status of one endpoint (use the endpoint token if you have it). The monitor token only reads: it lets you put the state on a third-party dashboard without handing over the owner's credential. With a schedule it is here that `next_expected_at` says when the next run is due. Only this endpoint carries `duration`: `p50_ms` (the low median, so always a duration that really happened) and `max_ms` over the last runs we measured, computed at read time over the event window we already keep — the list does not pay for it.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Monitor ID, from `Monitor.id`."
    },
    "token": {
      "type": "string",
      "description": "endpoint token (query)"
    },
    "guest_token": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Removes the owner's endpoint.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "ID of the monitor to deactivate."
    }
  },
  "required": [
    "guest_token",
    "id"
  ]
}

Latest ingest pings.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the monitor."
    },
    "token": {
      "type": "string",
      "description": "Monitor token, alternative to the `X-Hook-Token` header."
    },
    "guest_token": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Simulates the cron: GET on /in/:id. No credential on purpose — the caller is a cron, and the ID is already the secret. It costs nothing and there is no quota per ping.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Monitor ID, from `Monitor.ingest_url`."
    }
  },
  "required": [
    "id"
  ]
}

Says the run STARTED. Does not clear the dead-man clock: a routine that starts and hangs still becomes a miss. The next success records the duration. `start` is not proof of life: it does not move `last_event_at` and does not clear the miss counter, so a routine that starts and hangs still becomes a miss at the right time. The next success closes the run and records `last_duration_ms` — pass `?rid=` on both ends when runs can overlap, or the duration is measured against the wrong start. With `max_duration_sec` set on the monitor, a run left open past that ceiling alerts with `reason: "too_long"` on the next 5-minute check. Works by GET or POST.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Monitor ID, from `Monitor.ingest_url`."
    }
  },
  "required": [
    "id"
  ]
}

Says the run FAILED. The ingest never sends e-mail: the 5-minute cron turns it into an alert with reason `fail`, under the same one-per-24h cap. Failing is not proof of life either: the clock keeps running. The ingest never sends e-mail and never calls out — it records `alert_pending` and the cron turns it into an alert with `reason: "fail"` within 5 minutes, under the same one-per-24h cap. Works by GET or POST.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Monitor ID, from `Monitor.ingest_url`."
    }
  },
  "required": [
    "id"
  ]
}

The shell exit status: 0 behaves like a ping, 1-255 record the code as a failure. `curl -fsS $ORIGIN/in/ID/$?` at the end of a script is the whole integration. `0` behaves exactly like a plain ping; 1 to 255 record the code and leave the failure for the cron.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Monitor ID, from `Monitor.ingest_url`."
    },
    "exit_code": {
      "type": "number",
      "description": "Exit status, 0 to 255. Outside that range it is a 400."
    }
  },
  "required": [
    "id",
    "exit_code"
  ]
}

Returns (minting the first time) the key for /in/<key>/<slug>, where a ping creates its own monitor inside the free tier. Instruments a whole fleet with no setup call per job. One key per owner. Point a whole fleet at `/in/<key>/<slug>` and each job creates its monitor on the first check-in, **inside the free tier** — beyond it the ping answers 402 without creating anything. The key survives signing in: the crontab you deployed keeps working.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    }
  }
}

Rotates the ingest key; the previous one stops creating monitors. Existing ones keep working. Monitors already created keep working — rotating only revokes the power to create new ones.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    }
  }
}

Ping that creates its own monitor on the first hit. Same slug = same monitor; 402 when the free tier is full, and then nothing is written. The slug becomes the monitor name and its identity: the same slug always means the same monitor, so a retry never creates a second one. Normalised to lowercase, `[a-z0-9-]`, 40 chars. Creation happens **only inside the free tier** (or the trial); past it the ping is a 402 with `accepts[]` and nothing is written — not even the event. Works by GET or POST.

{
  "type": "object",
  "properties": {
    "ingestKey": {
      "type": "string",
      "description": "Ingest key, from `GET /api/ingest-key`.",
      "enum": [
        "hpk_exemplo"
      ]
    },
    "slug": {
      "type": "string",
      "description": "Name of the job; it becomes the monitor name."
    }
  },
  "required": [
    "ingestKey",
    "slug"
  ]
}

Free plan, x402 prices and the trial offer: an account = 90 days without the usage paywall, counted from its first use here (`trial` field; with a session it shows the state). Check before creating the second monitor or lowering the interval: it is the number IN FORCE, not the documentation's.

{
  "type": "object",
  "properties": {}
}

Public URL (JSON and RSS) with the status of all the owner's endpoints. The feed token only reads status: it does not create, change or delete. Whoever has the link sees the dashboard — treat it as a secret.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    }
  }
}

Rotates the status feed token; the previous URL stops working.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    }
  }
}

Ingest snippets and the JSON HookPulse POSTs on a miss. It exists so nobody guesses the alert format: `miss_json` and `recovery_json` here are the same bodies that arrive at your `alert_url`. Slack and Discord receive only the field they read.

{
  "type": "object",
  "properties": {}
}

Write to the people behind the product: a question, or a sponsorship/partnership/advertising proposal. Free, no captcha and no payment; one message every 10 s per network (one that arrives sooner waits its turn). One route for a question and for a sponsorship, partnership or ad proposal (`tipo`, with the placements of `GET /api/partners`). No captcha, no account, no payment. One message every 10 seconds per network: one that arrives sooner waits its turn and then goes out — no error. The message reaches the team by e-mail, with `email` as the reply address.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "What to call the person writing."
    },
    "email": {
      "type": "string",
      "description": "Where to reply."
    },
    "message": {
      "type": "string",
      "description": "What you want to say."
    },
    "tipo": {
      "type": "string",
      "enum": [
        "patrocinio",
        "parceria",
        "anuncio"
      ],
      "description": "Proposal: `patrocinio`, `parceria` or `anuncio`. Turns on the fields below."
    },
    "empresa": {
      "type": "string",
      "description": "Who is proposing, when it is a company."
    },
    "site": {
      "type": "string",
      "description": "Website of who is proposing."
    },
    "orcamento": {
      "type": "string",
      "enum": [
        "ate_100",
        "100_500",
        "500_2000",
        "2000_mais",
        "a_combinar"
      ],
      "description": "`ate_100`, `100_500`, `500_2000`, `2000_mais` or `a_combinar`."
    },
    "espaco": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Placement ids from `GET /api/partners`, up to 6."
    },
    "duracao": {
      "type": "string",
      "enum": [
        "30",
        "90",
        "365"
      ],
      "description": "Exposure in days: `30`, `90` or `365`."
    },
    "pagamento": {
      "type": "string",
      "enum": [
        "usdc",
        "deposito",
        "a_combinar"
      ],
      "description": "`usdc`, `deposito` or `a_combinar`."
    }
  },
  "required": [
    "name",
    "email",
    "message"
  ]
}

Current public prices and free allowances; no charge.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}