Partner Integration

Embed CORTX in your product

CORTX provides a public status badge, service status page, and JSON reliability API for every monitored service. Use these to show verification status on your README, website, or marketplace listing.

Find your Service ID in Services → select your service → Share panel. It is a UUID that looks like a1b2c3d4-…

Status Badge

Add a live badge to your README or website. It updates every 5 minutes and shows the current status, 30-day uptime, and paid delivery rate.

Markdown (README)

[![CORTX Monitored](https://usecortx.dev/api/badge/YOUR_SERVICE_ID)](https://usecortx.dev/status/service/YOUR_SERVICE_ID)

HTML

<a href="https://usecortx.dev/status/service/YOUR_SERVICE_ID">
  <img src="https://usecortx.dev/api/badge/YOUR_SERVICE_ID" alt="CORTX Monitored">
</a>

Badge image URL

https://usecortx.dev/api/badge/YOUR_SERVICE_ID

Replace YOUR_SERVICE_ID with your Service ID in all snippets above.

Service Status Page

A public, no-login-required status page for a single service. Shows 30-day metrics, 90-day availability bar, active incident, and recent incident history. Safe to link from your docs or support site.

URL

https://usecortx.dev/status/service/YOUR_SERVICE_ID

Nothing private is exposed — no test payload, no expected schema, no wallet details, no owner email.

Reliability API

A public JSON endpoint returning 30-day reliability metrics. No authentication required. Cached for 5 minutes.

Request

curl -s "https://usecortx.dev/api/v1/reliability/YOUR_SERVICE_ID" \
  -H "Accept: application/json"

Response — healthy service

{
  "service_id":              "abc123",
  "service_name":            "My API",
  "status":                  "operational",
  "window":                  "30d",
  "uptime_percent":          99.8,
  "paid_delivery_percent":   99.4,
  "schema_validity_percent": 100.0,
  "median_latency_ms":       4200,
  "last_verified_at":        "2026-08-14T10:00:00.000Z",
  "active_incident":         null
}

Response — active incident

{
  "active_incident": {
    "id":            "incident-uuid",
    "severity":      "critical",
    "failure_stage": "delivery",
    "opened_at":     "2026-08-14T08:30:00.000Z"
  }
}

Field	Type	Description
`service_id`	`string`	UUID of the service.
`service_name`	`string`	Display name of the service.
`status`	`string`	Current status: operational \| degraded \| critical \| unknown.
`window`	`"30d"`	Measurement window for all metrics.
`uptime_percent`	`number \| null`	Passed ÷ (passed + failed), 0–100 to one decimal. Null if no eligible checks.
`paid_delivery_percent`	`number \| null`	Checks where payment AND delivery both passed ÷ checks reaching both stages.
`schema_validity_percent`	`number \| null`	Checks passing schema_validation ÷ checks that reached that stage. Null if no schema configured.
`median_latency_ms`	`number \| null`	Median full round-trip latency in ms. Null if no data.
`last_verified_at`	`string \| null`	ISO 8601 timestamp of the most recent check.
`active_incident`	`object \| null`	Null if healthy. Object with id, severity, failure_stage, opened_at if incident is open.

The API returns 404 for unknown or deleted service IDs. Use the active_incident field to drive alerting logic in your marketplace or dashboard.

Use Cases

Marketplace listing verification

Poll the Reliability API to display live uptime and paid delivery metrics alongside a listed API service. Automatically flag services with active incidents or uptime below your threshold.

README badge

Add the Markdown badge to your API's README. It updates every 5 minutes and links to the public service status page — giving potential integrators confidence before they buy.

Status widget embedding

Embed the badge image in a landing page or documentation site. The SVG scales cleanly and adapts to light or dark backgrounds.

CI/CD gating

Query the Reliability API in a deployment pipeline. Block a release if uptime_percent < 99 or active_incident is non-null, ensuring you only deploy when your upstream dependencies are healthy.

Incident routing

Integrate with your incident management tool. When active_incident transitions from null to an object, open a ticket. When it returns to null, auto-resolve it.

Read the reliability methodology →