EvoHub Docs Sign in

Uptime API › Weekly summary

Turn the weekly summary on or off

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

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"
    }
  }
}
PUT/api/v1/uptime-digest

Turns the weekly summary on or off for the whole organization.

Only an owner or administrator signed in to EvoHub can do this. An API key always gets 403, whatever its scopes or role.

Requires the uptime:monitor:read scope, and a person who is an owner or administrator.

Authorization

Any one of:

Request body required

Content type: application/json

Type: object

  • enabled boolean required

Responses

200

The weekly summary settings, as the caller sees them.

Content type: application/json

Type: object

  • data DigestSettings
    Show DigestSettings properties
    • available boolean required
      Whether EvoHub sends the weekly summary at all. When false, nothing is sent whatever the other fields say.
    • enabled boolean required
      Whether the organization has it on.
    • subscribed boolean required
      Whether the caller receives it, if they are an owner or administrator.
    • can_manage boolean required
      Whether the caller may turn it on or off and send a preview. Always false for an API key.

400

The body is not {"enabled": true|false} (VALIDATION_ERROR).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Example: MONITOR_NOT_FOUND
    • message string required
      Example: monitor not found
    • request_id string

401

No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Example: MONITOR_NOT_FOUND
    • message string required
      Example: monitor not found
    • request_id string

403

The caller is not an owner or administrator signed in as a person, or lacks uptime:monitor:read (FORBIDDEN).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Example: MONITOR_NOT_FOUND
    • message string required
      Example: monitor not found
    • request_id string

429

Too many requests (RATE_LIMITED). Wait for Retry-After seconds.

Headers

  • Retry-After integer
    Seconds to wait before retrying.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Example: MONITOR_NOT_FOUND
    • message string required
      Example: monitor not found
    • request_id string

500

Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Example: MONITOR_NOT_FOUND
    • message string required
      Example: monitor not found
    • request_id string

Example request

curl -X PUT 'https://evohub.io/api/v1/uptime-digest' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "enabled": true
}'

Last updated