Skip to content
Docs navigation

Health and deprecations

Cross-cutting platform endpoints: a health probe, a data-freshness status document, and the published deprecations list. Health does not require authentication; status reports overall state, per-source freshness, and open incidents.

Watch these from an operations dashboard or a client that needs to fail closed when upstream data is stale. The deprecations document is how we announce a path that is leaving — including the mesoscale discussions alias.

curl "https://api.smarterweather.com/v1/health" \
  -H "Authorization: Bearer YOUR_API_KEY"
const res = await fetch(
  "https://api.smarterweather.com/v1/health",
  { headers: { Authorization: `Bearer ${process.env.SMARTERWEATHER_API_KEY}` } },
);
const data = await res.json();
import os, requests

data = requests.get(
    "https://api.smarterweather.com/v1/health",
    headers={"Authorization": f"Bearer {os.environ['SMARTERWEATHER_API_KEY']}"},
).json()
req, _ := http.NewRequest("GET",
  "https://api.smarterweather.com/v1/health",
  nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("SMARTERWEATHER_API_KEY"))
res, _ := http.DefaultClient.Do(req)

Health and deprecations reference

Rendered live from the canonical OpenAPI document. This is the canonical reference for the health and deprecations resource.

Loading API reference…