Vivere

List the pages this account can see: its own, then pages other accounts share with it, each with the access it has there (owner, editor or viewer) and how many monitors are on it and down.

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

List the monitors on every page this account can see, or on one page, with status, page and access. Monitors on a page shared to view have no id; address them by page_id and slug.

{
  "type": "object",
  "properties": {
    "page_id": {
      "description": "Only this page (from list_pages)",
      "type": "integer"
    }
  }
}

Get one monitor by id, including its ping URL for heartbeat monitors, or by page_id and slug, which also works on a page shared to view.

{
  "type": "object",
  "properties": {
    "id": {
      "description": "Monitor id, for monitors this account owns or edits",
      "type": "string"
    },
    "page_id": {
      "description": "Page id, with slug",
      "type": "integer"
    },
    "slug": {
      "description": "Monitor slug, with page_id",
      "type": "string"
    }
  }
}

Create a heartbeat monitor (default) or an HTTP check on the account's first page or on page_id, which may be a page shared with this account as editor. Returns the monitor and, for heartbeats, the ping URL to call after each run.

{
  "type": "object",
  "properties": {
    "cron": {
      "description": "Heartbeat alternative to period: five-field cron expression, e.g. '0 2 * * *'.",
      "type": "string"
    },
    "grace": {
      "description": "Heartbeat: how late a check-in may be before alerting, e.g. 15m. Default 15m.",
      "type": "string"
    },
    "interval": {
      "description": "HTTP check: how often to request it, e.g. 5m.",
      "type": "string"
    },
    "kind": {
      "description": "heartbeat (the job pings us) or http (we request a URL)",
      "enum": [
        "heartbeat",
        "http"
      ],
      "type": "string"
    },
    "name": {
      "description": "Human name, e.g. 'nightly report agent'",
      "type": "string"
    },
    "page_id": {
      "description": "Page to put it on (from list_pages). Default: the account's first page.",
      "type": "integer"
    },
    "period": {
      "description": "Heartbeat: expected time between successful check-ins, e.g. 30m, 1h, 1d. Default 1h.",
      "type": "string"
    },
    "tags": {
      "description": "Optional space-separated tags.",
      "type": "string"
    },
    "timezone": {
      "description": "IANA timezone for the cron expression, e.g. Asia/Seoul. Default UTC.",
      "type": "string"
    },
    "url": {
      "description": "HTTP check: the public URL to request.",
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

Report on a heartbeat monitor: 'success' after a completed run (resets the deadline), 'start' when a run begins, 'fail' when it failed. Include a short message; it is kept as the run log.

{
  "type": "object",
  "properties": {
    "message": {
      "description": "Optional summary or error text to store with the run",
      "type": "string"
    },
    "monitor_id": {
      "description": "Monitor id (the last path segment of the ping URL)",
      "type": "string"
    },
    "status": {
      "description": "Default success",
      "enum": [
        "success",
        "start",
        "fail"
      ],
      "type": "string"
    }
  },
  "required": [
    "monitor_id"
  ]
}

Pause a monitor so it stops alerting until resumed or pinged again.

{
  "type": "object",
  "properties": {
    "id": {
      "description": "Monitor id",
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Resume a paused monitor.

{
  "type": "object",
  "properties": {
    "id": {
      "description": "Monitor id",
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}