EvoHub Docs Sign in

Status API › Public pages

Read a public page by domain

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"
    }
  }
}
GET/api/v1/public/pages/by-domain/{domain}

The same as reading it by id, found by its custom domain. No API key.

Parameters

Path parameters

  • domain string required
    The page's custom domain, for example status.example.com (case-insensitive).
    Example: status.example.com

Responses

200

The page as visitors see it.

Content type: application/json

Type: object

  • data PublicPage required
    Show PublicPage properties
    • page object
      The page as visitors see it: the admin page object without org_id, team_id, reply_to_email and the analytics retention, with analytics reduced to {enabled, ga4_measurement_id, honor_privacy_signals}.
    • overall_status ComponentStatus
      One of: operational degraded partial_outage major_outage maintenance
    • components array of object
      • id string
      • name string
      • description string
      • source string
      • status ComponentStatus
        One of: operational degraded partial_outage major_outage maintenance
      • position integer
      • group string
      • uptime_percentage number
        Monitor-linked components: uptime over the page's history window.
      • uptime_history array of object
        • date string (date)
        • status string
        • up_ratio number
    • active_incidents array of object
      Open incidents: id, title, impact, status, started_at, resolved_at, affected_component_ids, updates[], postmortem, postmortem_published_at.
    • scheduled_maintenances array of object
    • past_incidents array of object
      Resolved within the page's history window.
    • product_pages array of object
      • name string
      • slug string
      • component_ids array of string
      • logo_url string
  • success boolean required
    Value: true

404

No public page with that id or domain (NOT_FOUND). A private page answers the same.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

429

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

Headers

  • Retry-After integer
    Seconds to wait.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

500

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

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

Example request

curl -X GET 'https://evohub.io/api/v1/public/pages/by-domain/status.example.com'

Last updated