Mark a deploy
record_deployRecords a deploy's commit or tag, completion time, and affected monitors so later verification and incident checks can identify it as a suspect deploy; it runs no check.
Instructions
Record that a deploy happened: the commit or tag (ref), when it finished (deployed_at) and which monitors it touched (monitor_ids, or tag + tag_match). Fettle stores it so that verify_deploy shows it and a later incident on those monitors can name it as the suspect deploy, with compare_url as the link. It runs no check. Call it only as part of a deploy check the user agreed to, or when the user asks, and only when you know the commit or tag. Repeating the same deployed_at and ref returns the stored marker, so on a retry reuse the exact deployed_at you sent first; a new value records a second deploy. Requires a key with the write scope. Limited to 10 calls per minute per calling address for an API key, per user for an app connection (never per key or organization); past that it is a 429 with the seconds to wait. Example: {"ref": "a1b2c3d", "deployed_at": "2026-11-01T10:02:00Z", "tag": ["service:api"]}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ref | Yes | The commit SHA, tag or branch: 1 to 200 printable characters with no spaces; anything else is a 422. | |
| tag | No | 1 to 10 tags that select the monitors, as in list_tags; not together with monitor_ids. Tags matching no monitor, or more than 100, are a 422. | |
| tag_match | No | With tag only: all (default) needs every tag, any needs at least one. | |
| compare_url | No | Optional https:// link to the diff, up to 2048 characters; shown as a link and never fetched. | |
| deployed_at | Yes | When the deploy finished, ISO 8601 with a UTC offset such as Z; without an offset it is a 422. At most 24 hours back and at most 300 seconds ahead. Together with ref it is the key that makes a retry safe: send the same value again. | |
| monitor_ids | No | 1 to 100 distinct monitor uuids from list_monitors, paused ones included; not together with tag. A repeated id is a 422; an id that is not a monitor of this organization is a 404 naming it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| ref | Yes | ||
| created_at | Yes | ||
| compare_url | Yes | ||
| deployed_at | Yes | ||
| monitor_ids | Yes |