EvoHub Docs Sign in

API reference

Uptime API

Use with AI
View as MarkdownThis page as plain text, for pasting into an AI tool Open in ClaudeAsk Claude questions about this page Open in ChatGPTAsk ChatGPT questions about this page
Connect to Cursor / VS Code / ClaudeSearch and read these docs from your AI tool (MCP server)

MCP server URL

https://docs-dev.evohub.io/mcp

Add to CursorAdd to VS Code

Claude Code

claude mcp add --transport http evohub-docs-docs https://docs-dev.evohub.io/mcp

Claude (claude.ai and Claude Desktop): Settings → Connectors → Add custom connector, and paste the URL above.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs-dev.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs-docs": {
      "type": "http",
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

Version 1.0 OpenAPI 3.1.0

Manage EvoHub Uptime from scripts and CI: create and change monitors, pause them, read their check history, uptime and SLA figures, mute alerts for planned work, and route alerts to notification channels.

Authentication. Every endpoint except the heartbeat ping takes an EvoHub API key, sent as Authorization: Bearer evohub_… or as X-API-Key: evohub_…. Each operation names the scope the key needs in its description and in x-evohub-permission. A missing or invalid key gets 401; a valid key without the scope gets 403, never 401. See the API overview, API keys and scopes, and Errors pages.

Responses. A successful answer carries its result in data. The analytics endpoint also sends "success": true. Errors carry an error object with a machine-readable code. Timestamps are RFC 3339 in UTC.

Teams. A monitor either belongs to the whole organization (team_id is "") or to one team. A request sees the organization-wide monitors plus those of the teams it is in; an organization key scoped to a team sees that team's. A monitor the caller cannot see answers 404 MONITOR_NOT_FOUND, exactly like one that does not exist.

Heartbeat pings. /ping/{token} is not an API-key endpoint: the token in the URL is the credential, so a cron job can call it with a bare curl.

Servers

  • https://evohub.io

Authentication

  • bearerKey HTTP Bearer
    An EvoHub API key (evohub_…) as a bearer token.
  • headerKey API key in the header X-API-Key
    An EvoHub API key (evohub_…).

Monitors

Create, read, change, pause and delete monitors.

GET/api/v1/monitorsList monitors
POST/api/v1/monitorsCreate a monitor
GET/api/v1/monitors/attentionList monitors that need attention
GET/api/v1/monitors/{id}Get a monitor
DELETE/api/v1/monitors/{id}Delete a monitor
PATCH/api/v1/monitors/{id}Update, pause or resume a monitor

Checks and uptime

A monitor's check results, outages and uptime figures.

GET/api/v1/monitors/{id}/checksList a monitor's checks
GET/api/v1/monitors/{id}/incidentsList a monitor's outages
GET/api/v1/monitors/{id}/uptimeGet a monitor's uptime
GET/api/v1/monitors/{id}/uptime/dailyGet a monitor's uptime per day

Analytics

Uptime, latency and SLA across every monitor you can see.

GET/api/v1/uptime/analyticsGet uptime analytics

Silence

Mute alerts for the whole organization or for one monitor's maintenance window.

GET/api/v1/silenceGet the organization's silence
PUT/api/v1/silenceSilence all alerts
DELETE/api/v1/silenceEnd the silence
GET/api/v1/monitors/{id}/silenceGet a monitor's silence window
PUT/api/v1/monitors/{id}/silenceSilence a monitor for a window
DELETE/api/v1/monitors/{id}/silenceClear a monitor's silence window

Notification channels

Where alerts go besides On-Call, and which monitors use each channel.

GET/api/v1/notification-channelsList notification channels
POST/api/v1/notification-channelsCreate a notification channel
GET/api/v1/notification-channels/chat-appsList chat app channels
DELETE/api/v1/notification-channels/{id}Delete a notification channel
GET/api/v1/monitors/{id}/channelsList a monitor's channels
POST/api/v1/monitors/{id}/channels/{chId}Link a channel to a monitor
DELETE/api/v1/monitors/{id}/channels/{chId}Unlink a channel from a monitor

Weekly summary

The weekly uptime summary email.

GET/api/v1/uptime-digestGet the weekly summary settings
PUT/api/v1/uptime-digestTurn the weekly summary on or off
PUT/api/v1/uptime-digest/meSubscribe or unsubscribe yourself
POST/api/v1/uptime-digest/previewEmail yourself a preview

Audit log

Who changed what in Uptime.

GET/api/v1/uptime-audit-logsList Uptime audit log entries

Heartbeat pings

The URL a heartbeat monitor's job calls.

GET/ping/{token}Ping a heartbeat monitor
POST/ping/{token}Ping a heartbeat monitor (POST)
HEAD/ping/{token}Ping a heartbeat monitor (HEAD)

Last updated