Skip to content

Open-source status page, incident response and uptime monitoring

fix: is-agentic take-aways (#2600)

Maximilian Kaske21410705fce6
diff --git a/apps/server/Dockerfile b/apps/server/Dockerfile
index 53c0a483b..bb560e10c 100644
--- a/apps/server/Dockerfile
+++ b/apps/server/Dockerfile
@@ -76,7 +76,7 @@ COPY \
"/app/packages" "/app/packages"
RUN <<EOF
deno bundle --platform=deno --sloppy-imports --node-modules-dir=manual --output src/_serve.bundle.mjs src/serve.ts
-deno compile --no-check -A --node-modules-dir=none --include static/openapi.yaml --include static/openapi-v1.json --output app src/_serve.bundle.mjs
+deno compile --no-check -A --node-modules-dir=none --include static/openapi.yaml --include static/openapi.json --include static/openapi-v1.json --output app src/_serve.bundle.mjs
EOF
# runtime
diff --git a/apps/server/dofigen.lock b/apps/server/dofigen.lock
index 27b96cbba..87984b9b3 100644
--- a/apps/server/dofigen.lock
+++ b/apps/server/dofigen.lock
@@ -16,8 +16,8 @@ effective: |
digest: sha256:69a9f3033e3f381770452648b1cbf4ae96ea409f7ef24f30afeff3d380705f62
label:
org.opencontainers.image.stage: build
- org.opencontainers.image.base.digest: sha256:69a9f3033e3f381770452648b1cbf4ae96ea409f7ef24f30afeff3d380705f62
org.opencontainers.image.base.name: docker.io/denoland/deno:2.9.2
+ org.opencontainers.image.base.digest: sha256:69a9f3033e3f381770452648b1cbf4ae96ea409f7ef24f30afeff3d380705f62
workdir: /app/apps/server
env:
NODE_ENV: production
@@ -39,7 +39,7 @@ effective: |
target: /app/packages
run:
- deno bundle --platform=deno --sloppy-imports --node-modules-dir=manual --output src/_serve.bundle.mjs src/serve.ts
- - deno compile --no-check -A --node-modules-dir=none --include static/openapi.yaml --include static/openapi-v1.json --output app src/_serve.bundle.mjs
+ - deno compile --no-check -A --node-modules-dir=none --include static/openapi.yaml --include static/openapi.json --include static/openapi-v1.json --output app src/_serve.bundle.mjs
install:
fromImage:
path: node
@@ -131,13 +131,13 @@ effective: |
path: hi/curl
digest: sha256:848b81ab5d5e55371d7193fd4f1ea7b605d14dbb039344ffad34a4c1f0d880f4
label:
- io.dofigen.version: 2.8.0
- org.opencontainers.image.title: OpenStatus Server
- org.opencontainers.image.base.digest: sha256:848b81ab5d5e55371d7193fd4f1ea7b605d14dbb039344ffad34a4c1f0d880f4
- org.opencontainers.image.source: https://github.com/openstatusHQ/openstatus
org.opencontainers.image.vendor: OpenStatus
- org.opencontainers.image.authors: OpenStatus Team
org.opencontainers.image.description: REST API server with Hono framework for OpenStatus
+ org.opencontainers.image.source: https://github.com/openstatusHQ/openstatus
+ org.opencontainers.image.base.digest: sha256:848b81ab5d5e55371d7193fd4f1ea7b605d14dbb039344ffad34a4c1f0d880f4
+ io.dofigen.version: 2.8.0
+ org.opencontainers.image.authors: OpenStatus Team
+ org.opencontainers.image.title: OpenStatus Server
user:
user: '1000'
group: '1000'
@@ -169,7 +169,7 @@ images:
digest: sha256:69a9f3033e3f381770452648b1cbf4ae96ea409f7ef24f30afeff3d380705f62
resources:
dofigen.yml:
- hash: e62db1a487a23f2bce5f3353470c8923b67cd6b5a1a78bef29bc448bd3571094
+ hash: e8b2176a3c4d7a56e6a9b32654f7b18019c3986e536314e9bb7a632a9a8b72fe
content: |
# Files to exclude from Docker context
ignore:
@@ -256,7 +256,7 @@ resources:
# 2) compile the bundle with node-modules-dir=none so node_modules is NOT embedded — keeps the binary ~110MB instead of ~390MB.
run:
- deno bundle --platform=deno --sloppy-imports --node-modules-dir=manual --output src/_serve.bundle.mjs src/serve.ts
- - deno compile --no-check -A --node-modules-dir=none --include static/openapi.yaml --include static/openapi-v1.json --output app src/_serve.bundle.mjs
+ - deno compile --no-check -A --node-modules-dir=none --include static/openapi.yaml --include static/openapi.json --include static/openapi-v1.json --output app src/_serve.bundle.mjs
# Runtime stage: distroless glibc base that already ships curl (for the healthcheck).
# Pinned to the multi-arch index digest of hi/curl:latest — dofigen mis-resolves this registry's tag to an unpullable digest.
diff --git a/apps/server/dofigen.yml b/apps/server/dofigen.yml
index 2735187b1..a6cc71431 100644
--- a/apps/server/dofigen.yml
+++ b/apps/server/dofigen.yml
@@ -83,7 +83,7 @@ builders:
# 2) compile the bundle with node-modules-dir=none so node_modules is NOT embedded — keeps the binary ~110MB instead of ~390MB.
run:
- deno bundle --platform=deno --sloppy-imports --node-modules-dir=manual --output src/_serve.bundle.mjs src/serve.ts
- - deno compile --no-check -A --node-modules-dir=none --include static/openapi.yaml --include static/openapi-v1.json --output app src/_serve.bundle.mjs
+ - deno compile --no-check -A --node-modules-dir=none --include static/openapi.yaml --include static/openapi.json --include static/openapi-v1.json --output app src/_serve.bundle.mjs
# Runtime stage: distroless glibc base that already ships curl (for the healthcheck).
# Pinned to the multi-arch index digest of hi/curl:latest — dofigen mis-resolves this registry's tag to an unpullable digest.
diff --git a/apps/server/package.json b/apps/server/package.json
index ea95d9a9d..c76fb8649 100644
--- a/apps/server/package.json
+++ b/apps/server/package.json
@@ -10,7 +10,8 @@
"start": "NODE_ENV=production deno run -A --sloppy-imports src/serve.ts",
"test": "deno test --parallel -A --no-check --sloppy-imports --env-file=.env.test --import-map=test.importmap.json",
"check": "deno check --sloppy-imports src/serve.ts",
- "eval:mcp": "deno run -A --sloppy-imports src/routes/mcp/evals/run.ts"
+ "eval:mcp": "deno run -A --sloppy-imports src/routes/mcp/evals/run.ts",
+ "openapi:json": "deno run -A scripts/build-openapi-json.ts && pnpm exec oxfmt static/openapi.json static/openapi-yaml.ts"
},
"dependencies": {
"@ai-sdk/anthropic": "catalog:",
diff --git a/apps/server/scripts/build-openapi-json.ts b/apps/server/scripts/build-openapi-json.ts
new file mode 100644
index 000000000..775287950
--- /dev/null
+++ b/apps/server/scripts/build-openapi-json.ts
@@ -0,0 +1,26 @@
+import { parse } from "jsr:@std/yaml@^1.0.9";
+
+/**
+ * `static/openapi.json` is a JSON rendering of `static/openapi.yaml`, which is
+ * itself generated from the protos (`pnpm --filter @openstatus/proto buf:openapi`).
+ * Agents and OpenAPI tooling overwhelmingly expect `/openapi.json`; hand-editing
+ * either file drifts them apart, which `openapi.test.ts` fails on.
+ *
+ * `openapi-yaml.ts` embeds the YAML as a module because `deno bundle` flattens
+ * `src/` into a single file: a path resolved from `import.meta.url` at runtime
+ * would point at the bundle's directory, not the source module's.
+ *
+ * Run: `pnpm --filter @openstatus/server openapi:json`
+ */
+const dir = new URL("../static/", import.meta.url);
+const yaml = await Deno.readTextFile(new URL("openapi.yaml", dir));
+await Deno.writeTextFile(
+ new URL("openapi.json", dir),
+ `${JSON.stringify(parse(yaml), null, 2)}\n`,
+);
+await Deno.writeTextFile(
+ new URL("openapi-yaml.ts", dir),
+ `// Generated from openapi.yaml — run \`pnpm --filter @openstatus/server openapi:json\`.\nexport default ${JSON.stringify(
+ yaml,
+ )};\n`,
+);
diff --git a/apps/server/src/index.ts b/apps/server/src/index.ts
index 1debaeaf2..e80fb143b 100644
--- a/apps/server/src/index.ts
+++ b/apps/server/src/index.ts
@@ -24,10 +24,10 @@ import { showRoutes } from "hono/dev";
import { prettyJSON } from "hono/pretty-json";
import { requestId } from "hono/request-id";
-import openapiV1Json from "../static/openapi-v1.json" with { type: "json" };
import { env } from "./env";
import { handleError } from "./libs/errors";
import { mcpRoute } from "./routes/mcp";
+import { openapiRoute } from "./routes/openapi";
import { publicRoute } from "./routes/public";
import { mountRpcRoutes } from "./routes/rpc";
import { slackRoute } from "./routes/slack";
@@ -47,10 +47,6 @@ export const app = new Hono<Env>({
const logger = getLogger("api-server");
const otelLogger = getLogger("api-server-otel");
-const openapiYaml = await Deno.readTextFile(
- new URL("../static/openapi.yaml", import.meta.url),
-);
-
/**
* Configure logging asynchronously without blocking module initialization.
* This allows tests to import `app` immediately.
@@ -222,14 +218,7 @@ app.get("/ping", (c) => {
);
});
-app.get("/openapi.yaml", (c) => {
- return c.text(openapiYaml, 200, { "Content-Type": "application/yaml" });
-});
-app.get("/openapi-v1.json", (c) => {
- return c.text(JSON.stringify(openapiV1Json), 200, {
- "Content-Type": "application/json",
- });
-});
+app.route("/", openapiRoute);
app.get(
"/openapi",
diff --git a/apps/server/src/routes/mcp/handler.test.ts b/apps/server/src/routes/mcp/handler.test.ts
index fbffb4af3..125fba7e9 100644
--- a/apps/server/src/routes/mcp/handler.test.ts
+++ b/apps/server/src/routes/mcp/handler.test.ts
@@ -70,12 +70,43 @@ async function readJsonRpc(
}
describe("MCP transport", () => {
- test("rejects requests missing x-openstatus-key with 401", async () => {
+ test("serves the public documents without a key", async () => {
+ const app = makeApp();
+ const res = await app.fetch(jsonRpc({ method: "resources/list" }, false));
+ expect(res.status).toBe(200);
+ const body = await readJsonRpc(res);
+ const resources = (body.result as { resources: { uri: string }[] })
+ .resources;
+ expect(resources.length).toBeGreaterThan(0);
+ });
+
+ test("registers no tools without a key", async () => {
const app = makeApp();
const res = await app.fetch(jsonRpc({ method: "tools/list" }, false));
+ // No tool handler is registered on the anonymous server, so the method
+ // itself is absent — an empty tool list would still be a workspace-shaped
+ // response to an unauthenticated caller.
+ const body = await readJsonRpc(res);
+ expect(body.result).toBeUndefined();
+ expect(body.error?.code).toBe(-32601);
+ });
+
+ test("a present but empty key is a 401, not the public surface", async () => {
+ const app = makeApp();
+ const res = await app.fetch(jsonRpc({ method: "resources/list" }, ""));
expect(res.status).toBe(401);
});
+ test("resources/list is also served to an authenticated key", async () => {
+ const app = makeApp();
+ const res = await app.fetch(jsonRpc({ method: "resources/list" }));
+ expect(res.status).toBe(200);
+ const body = await readJsonRpc(res);
+ const resources = (body.result as { resources: { uri: string }[] })
+ .resources;
+ expect(resources.length).toBeGreaterThan(0);
+ });
+
test("tools/list returns the expected registered tool set", async () => {
const app = makeApp();
const res = await app.fetch(jsonRpc({ method: "tools/list" }));
diff --git a/apps/server/src/routes/mcp/index.ts b/apps/server/src/routes/mcp/index.ts
index 822c47f43..6821a285d 100644
--- a/apps/server/src/routes/mcp/index.ts
+++ b/apps/server/src/routes/mcp/index.ts
@@ -1,11 +1,13 @@
import { StreamableHTTPTransport } from "@hono/mcp";
+import type { Workspace } from "@openstatus/db/src/schema";
import { Hono } from "hono";
+import type { Context, Next } from "hono";
import { handleError } from "../../libs/errors";
import { authMiddleware } from "../../libs/middlewares/auth";
import type { Variables } from "../../types";
import { toServiceCtx } from "./adapter";
-import { createMcpServer } from "./server";
+import { createMcpServer, createPublicMcpServer } from "./server";
export const mcpRoute = new Hono<{ Variables: Variables }>({ strict: false });
@@ -16,7 +18,25 @@ export const mcpRoute = new Hono<{ Variables: Variables }>({ strict: false });
// across mount points and self-contained for tests.
mcpRoute.onError(handleError);
-mcpRoute.use("*", authMiddleware);
+/**
+ * An MCP client `initialize`s before it has a credential, and a handshake that
+ * 401s reads as an unreachable server rather than a protected one. A missing
+ * key drops the request to the public surface (documents only, no tools); a
+ * key that is present but invalid is still a 401, so a misconfigured client
+ * gets told so instead of silently losing its workspace.
+ */
+async function optionalAuthMiddleware(
+ c: Context<{ Variables: Variables }, "/*">,
+ next: Next,
+) {
+ // `=== undefined` rather than a truthiness check: a client that sends the
+ // header with an empty value is misconfigured, not anonymous, and should be
+ // told so instead of silently dropping to the public surface.
+ if (c.req.header("x-openstatus-key") === undefined) return next();
+ return authMiddleware(c, next);
+}
+
+mcpRoute.use("*", optionalAuthMiddleware);
/**
* The transport handler MUST return a JSON-RPC error envelope on
@@ -27,14 +47,10 @@ mcpRoute.use("*", authMiddleware);
* surface as HTTP 401, which is correct.
*/
mcpRoute.all("/", async (c) => {
- const workspace = c.get("workspace");
+ // Anonymous requests reach here with `workspace` unset, which `Variables`
+ // (shared with the authenticated V1 surface) cannot express.
+ const workspace = c.get("workspace") as Workspace | undefined;
const requestId = c.get("requestId");
- const apiKey = c.get("apiKey");
- const ctx = toServiceCtx({
- workspace,
- apiKey,
- requestId,
- });
// Pre-parse the JSON-RPC body so we can mirror the request `id` on
// any error envelope we synthesize below. Per JSON-RPC 2.0 the
@@ -63,7 +79,11 @@ mcpRoute.all("/", async (c) => {
// NOT call `server.close()` in a `finally` — closing tears down the
// SSE stream before Hono finishes writing the body, sending an
// empty response to the client.
- const server = createMcpServer(ctx);
+ const server = workspace
+ ? createMcpServer(
+ toServiceCtx({ workspace, apiKey: c.get("apiKey"), requestId }),
+ )
+ : createPublicMcpServer();
const transport = new StreamableHTTPTransport();
try {
await server.connect(transport);
diff --git a/apps/server/src/routes/mcp/resources.test.ts b/apps/server/src/routes/mcp/resources.test.ts
new file mode 100644
index 000000000..39b5e6e56
--- /dev/null
+++ b/apps/server/src/routes/mcp/resources.test.ts
@@ -0,0 +1,155 @@
+import { Client } from "@modelcontextprotocol/sdk/client/index.js";
+import { InMemoryTransport } from "@modelcontextprotocol/sdk/inMemory.js";
+import { expect } from "@std/expect";
+import { afterEach, describe, test } from "@std/testing/bdd";
+
+import { PUBLIC_RESOURCES, readPublicResource } from "./resources";
+import { createPublicMcpServer } from "./server";
+
+const realFetch = globalThis.fetch;
+
+afterEach(() => {
+ globalThis.fetch = realFetch;
+});
+
+function stubFetch(impl: () => Promise<Response>) {
+ globalThis.fetch = impl as unknown as typeof fetch;
+}
+
+describe("public MCP resources", () => {
+ test("every entry is addressable and typed", () => {
+ expect(PUBLIC_RESOURCES.length).toBeGreaterThan(0);
+ const names = new Set<string>();
+ for (const resource of PUBLIC_RESOURCES) {
+ expect(resource.uri.startsWith("https://")).toBe(true);
+ expect(resource.mimeType.length).toBeGreaterThan(0);
+ expect(resource.description.length).toBeGreaterThan(0);
+ expect(names.has(resource.name)).toBe(false);
+ names.add(resource.name);
+ }
+ });
+
+ test("reads echo the declared uri and mimeType", async () => {
+ stubFetch(() => Promise.resolve(new Response("# doc")));
+ for (const resource of PUBLIC_RESOURCES) {
+ const result = await readPublicResource(resource);
+ expect(result.contents).toHaveLength(1);
+ expect(result.contents[0].uri).toBe(resource.uri);
+ expect(result.contents[0].mimeType).toBe(resource.mimeType);
+ }
+ });
+
+ test("never returns an empty body when the document is unreachable", async () => {
+ stubFetch(() => Promise.reject(new Error("network down")));
+ for (const resource of PUBLIC_RESOURCES) {
+ const result = await readPublicResource(resource);
+ expect(String(result.contents[0].text).length).toBeGreaterThan(0);
+ }
+ });
+
+ test("falls back rather than serving a blank document", async () => {
+ const remote = PUBLIC_RESOURCES.find((r) => r.name === "site-index");
+ if (!remote) throw new Error("site-index resource missing");
+
+ stubFetch(() => Promise.resolve(new Response(" ")));
+ const blank = await readPublicResource(remote);
+ expect(String(blank.contents[0].text).trim().length).toBeGreaterThan(0);
+
+ stubFetch(() =>
+ Promise.resolve(new Response("not found", { status: 404 })),
+ );
+ const missing = await readPublicResource(remote);
+ expect(String(missing.contents[0].text).trim().length).toBeGreaterThan(0);
+ });
+
+ test("serves the fetched document when it resolves", async () => {
+ const remote = PUBLIC_RESOURCES.find(
+ (r) => r.name === "mcp-server-reference",
+ );
+ if (!remote) throw new Error("mcp-server-reference resource missing");
+
+ stubFetch(() => Promise.resolve(new Response("# MCP server\n\nlive copy")));
+ const result = await readPublicResource(remote);
+ expect(result.contents[0].text).toContain("live copy");
+ });
+
+ test("ships the OpenAPI document without a network call", async () => {
+ stubFetch(() => Promise.reject(new Error("must not be called")));
+ const spec = PUBLIC_RESOURCES.find(
+ (r) => r.name === "openapi-specification",
+ );
+ if (!spec) throw new Error("openapi resource missing");
+
+ const result = await readPublicResource(spec);
+ const parsed = JSON.parse(String(result.contents[0].text));
+ expect(parsed.openapi).toBe("3.1.0");
+ expect(parsed.servers[0].url).toBe("https://api.openstatus.dev");
+ });
+});
+
+/** Connect a client to the anonymous server the route actually builds. */
+async function connectPublicServer() {
+ const server = createPublicMcpServer();
+ const client = new Client({ name: "probe", version: "test" });
+ const [clientTransport, serverTransport] =
+ InMemoryTransport.createLinkedPair();
+ await Promise.all([
+ server.connect(serverTransport),
+ client.connect(clientTransport),
+ ]);
+ return { client, close: () => client.close() };
+}
+
+describe("anonymous MCP surface", () => {
+ test("advertises the resources capability on initialize", async () => {
+ stubFetch(() => Promise.resolve(new Response("# doc")));
+ const { client, close } = await connectPublicServer();
+ try {
+ expect(client.getServerCapabilities()?.resources).toBeDefined();
+ expect(client.getServerCapabilities()?.tools).toBeUndefined();
+ } finally {
+ await close();
+ }
+ });
+
+ test("resources/list returns every public document", async () => {
+ stubFetch(() => Promise.resolve(new Response("# doc")));
+ const { client, close } = await connectPublicServer();
+ try {
+ const { resources } = await client.listResources();
+ expect(resources.map((r) => r.uri).sort()).toEqual(
+ PUBLIC_RESOURCES.map((r) => r.uri).sort(),
+ );
+ for (const resource of resources) {
+ expect(resource.name.length).toBeGreaterThan(0);
+ expect(resource.description?.length).toBeGreaterThan(0);
+ expect(resource.mimeType?.length).toBeGreaterThan(0);
+ }
+ } finally {
+ await close();
+ }
+ });
+
+ test("resources/read returns a non-empty body for each", async () => {
+ stubFetch(() => Promise.resolve(new Response("# doc")));
+ const { client, close } = await connectPublicServer();
+ try {
+ for (const resource of PUBLIC_RESOURCES) {
+ const result = await client.readResource({ uri: resource.uri });
+ expect(String(result.contents[0].text).length).toBeGreaterThan(0);
+ }
+ } finally {
+ await close();
+ }
+ });
+
+ test("exposes no tools without a key", async () => {
+ stubFetch(() => Promise.resolve(new Response("# doc")));
+ const { client, close } = await connectPublicServer();
+ try {
+ await expect(client.listTools()).rejects.toThrow();
+ } finally {
+ await close();
+ }
+ });
+});
diff --git a/apps/server/src/routes/mcp/resources.ts b/apps/server/src/routes/mcp/resources.ts
new file mode 100644
index 000000000..7e680ce50
--- /dev/null
+++ b/apps/server/src/routes/mcp/resources.ts
@@ -0,0 +1,106 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { ReadResourceResult } from "@modelcontextprotocol/sdk/types.js";
+
+import openapiJson from "../../../static/openapi.json" with { type: "json" };
+
+const SPEC_BODY = JSON.stringify(openapiJson);
+const FETCH_TIMEOUT_MS = 5_000;
+
+type PublicResource = {
+ name: string;
+ uri: string;
+ title: string;
+ description: string;
+ mimeType: string;
+ read: () => Promise<string>;
+};
+
+/**
+ * A `resources/read` must never resolve to an empty body — an empty resource
+ * reads as a broken server and JSON-RPC has no "try later". Documents fetched
+ * over the network fall back to a pointer at the same URI.
+ */
+async function fetchText(resource: {
+ uri: string;
+ title: string;
+ mimeType: string;
+}): Promise<string> {
+ const fallback = `${resource.title} could not be fetched. Read it at ${resource.uri}.\n`;
+ try {
+ const res = await fetch(resource.uri, {
+ headers: { Accept: resource.mimeType, "User-Agent": "openstatus-mcp" },
+ signal: AbortSignal.timeout(FETCH_TIMEOUT_MS),
+ });
+ if (!res.ok) return fallback;
+ const body = (await res.text()).trim();
+ return body.length > 0 ? body : fallback;
+ } catch {
+ return fallback;
+ }
+}
+
+function remote(resource: Omit<PublicResource, "read">): PublicResource {
+ return { ...resource, read: () => fetchText(resource) };
+}
+
+export const PUBLIC_RESOURCES: PublicResource[] = [
+ {
+ name: "openapi-specification",
+ uri: "https://api.openstatus.dev/openapi.json",
+ title: "openstatus OpenAPI specification",
+ description:
+ "Machine-readable description of the openstatus HTTP API: every operation with a unique operationId, typed parameters, and response schemas.",
+ mimeType: "application/json",
+ read: () => Promise.resolve(SPEC_BODY),
+ },
+ remote({
+ name: "mcp-server-reference",
+ uri: "https://www.openstatus.dev/docs/reference/mcp-server",
+ title: "openstatus MCP server reference",
+ description:
+ "Transport, authentication, and the full tool list for this MCP server.",
+ mimeType: "text/markdown",
+ }),
+ remote({
+ name: "site-index",
+ uri: "https://www.openstatus.dev/llms.txt",
+ title: "openstatus site index for agents",
+ description:
+ "llms.txt: product context, pricing, and a linked index of every page on openstatus.dev.",
+ mimeType: "text/plain",
+ }),
+];
+
+export async function readPublicResource(
+ resource: PublicResource,
+): Promise<ReadResourceResult> {
+ return {
+ contents: [
+ {
+ uri: resource.uri,
+ mimeType: resource.mimeType,
+ text: await resource.read(),
+ },
+ ],
+ };
+}
+
+/**
+ * Registered on every server, authenticated or not: they carry no workspace
+ * data, and they are what an anonymous client reads to learn how to
+ * authenticate.
+ */
+export function registerPublicResources(server: McpServer): void {
+ for (const resource of PUBLIC_RESOURCES) {
+ server.registerResource(
+ resource.name,
+ resource.uri,
+ {
+ title: resource.title,
+ description: resource.description,
+ mimeType: resource.mimeType,
+ },
+ () => readPublicResource(resource),
+ );
+ }
+}
diff --git a/apps/server/src/routes/mcp/server.ts b/apps/server/src/routes/mcp/server.ts
index 280850c25..f7c4140e2 100644
--- a/apps/server/src/routes/mcp/server.ts
+++ b/apps/server/src/routes/mcp/server.ts
@@ -2,6 +2,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import type { ServiceContext } from "@openstatus/services";
import packageJson from "../../../package.json" with { type: "json" };
+import { registerPublicResources } from "./resources";
import { registerAuditTools } from "./tools/audit";
import { registerMaintenanceTools } from "./tools/maintenance";
import { registerMonitorTools } from "./tools/monitor";
@@ -18,13 +19,15 @@ import { registerStatusReportTools } from "./tools/status-report";
* and its transport are scoped to a single request and become
* garbage-collectable once the response stream is consumed.
*
- * Static tool list (`listChanged: false`); no prompts or resources.
+ * Static tool list (`listChanged: false`); no prompts. Resources are the
+ * public documents from `./resources` — they carry no workspace data.
*/
export function createMcpServer(ctx: ServiceContext): McpServer {
const server = new McpServer(
{ name: "openstatus", version: packageJson.version },
{ capabilities: { tools: { listChanged: false } } },
);
+ registerPublicResources(server);
registerPageTools(server, ctx);
registerStatusReportTools(server, ctx);
registerMaintenanceTools(server, ctx);
@@ -34,3 +37,19 @@ export function createMcpServer(ctx: ServiceContext): McpServer {
registerAuditTools(server, ctx);
return server;
}
+
+/**
+ * Server for a request that carried no `x-openstatus-key`. MCP clients
+ * `initialize` before they have a credential, and an endpoint that refuses the
+ * handshake reads as unreachable rather than as protected. No tool is
+ * registered, so `tools/list` and `tools/call` are absent — not empty — and
+ * nothing workspace-scoped is reachable without a key.
+ */
+export function createPublicMcpServer(): McpServer {
+ const server = new McpServer({
+ name: "openstatus",
+ version: packageJson.version,
+ });
+ registerPublicResources(server);
+ return server;
+}
diff --git a/apps/server/src/routes/openapi.test.ts b/apps/server/src/routes/openapi.test.ts
new file mode 100644
index 000000000..43fef5e30
--- /dev/null
+++ b/apps/server/src/routes/openapi.test.ts
@@ -0,0 +1,60 @@
+import { expect } from "@std/expect";
+import { describe, test } from "@std/testing/bdd";
+import { Hono } from "hono";
+import { parse as parseYaml } from "jsr:@std/yaml@^1.0.9";
+
+import openapiYaml from "../../static/openapi-yaml";
+import openapiJson from "../../static/openapi.json" with { type: "json" };
+import { openapiRoute } from "./openapi";
+
+const app = new Hono().route("/", openapiRoute);
+
+describe("OpenAPI documents", () => {
+ test("openapi.json is a faithful rendering of openapi.yaml", async () => {
+ const yaml = parseYaml(
+ await Deno.readTextFile(
+ new URL("../../static/openapi.yaml", import.meta.url),
+ ),
+ );
+ expect(JSON.parse(JSON.stringify(openapiJson))).toEqual(yaml);
+ });
+
+ test("the embedded YAML module matches openapi.yaml on disk", async () => {
+ expect(openapiYaml).toBe(
+ await Deno.readTextFile(
+ new URL("../../static/openapi.yaml", import.meta.url),
+ ),
+ );
+ });
+
+ test("declares the production server so agents can resolve paths", () => {
+ expect(openapiJson.servers).toEqual([
+ { url: "https://api.openstatus.dev", description: "Production" },
+ ]);
+ });
+
+ test("GET /openapi.json serves a CORS-readable spec", async () => {
+ const res = await app.request("/openapi.json");
+ expect(res.status).toBe(200);
+ expect(res.headers.get("content-type")).toContain("application/json");
+ expect(res.headers.get("access-control-allow-origin")).toBe("*");
+ const body = await res.json();
+ expect(body.openapi).toBe("3.1.0");
+ expect(Object.keys(body.paths).length).toBeGreaterThan(0);
+ expect(body.servers[0].url).toBe("https://api.openstatus.dev");
+ });
+
+ test("GET /openapi.yaml still serves YAML", async () => {
+ const res = await app.request("/openapi.yaml");
+ expect(res.status).toBe(200);
+ expect(res.headers.get("content-type")).toContain("application/yaml");
+ expect(await res.text()).toContain("openapi: 3.1.0");
+ });
+
+ test("GET /openapi-v1.json still serves the deprecated v1 spec", async () => {
+ const res = await app.request("/openapi-v1.json");
+ expect(res.status).toBe(200);
+ const body = await res.json();
+ expect(body.info.version).toBe("1.0.0");
+ });
+});
diff --git a/apps/server/src/routes/openapi.ts b/apps/server/src/routes/openapi.ts
new file mode 100644
index 000000000..2b8e8bb25
--- /dev/null
+++ b/apps/server/src/routes/openapi.ts
@@ -0,0 +1,46 @@
+import { Hono } from "hono";
+
+import openapiV1Json from "../../static/openapi-v1.json" with { type: "json" };
+// Generated alongside openapi.json; embedded rather than read from disk because
+// `deno bundle` flattens src/ and a runtime path would resolve from the bundle.
+import openapiYaml from "../../static/openapi-yaml";
+import openapiJson from "../../static/openapi.json" with { type: "json" };
+
+// Serialized once: the documents are ~320 KB and never change at runtime.
+const openapiJsonBody = JSON.stringify(openapiJson);
+const openapiV1JsonBody = JSON.stringify(openapiV1Json);
+
+// The specs are public and unauthenticated; an agent fetching one from a
+// browser needs the CORS header to read the body at all.
+const specHeaders = {
+ "Access-Control-Allow-Origin": "*",
+ "Cache-Control": "public, max-age=3600",
+};
+
+/**
+ * The machine-readable API descriptions. `openapi.json` is the path agents and
+ * OpenAPI tooling probe by convention; `openapi.yaml` is the generated source
+ * both are rendered from (see `scripts/build-openapi-json.ts`).
+ */
+export const openapiRoute = new Hono({ strict: false });
+
+openapiRoute.get("/openapi.yaml", (c) =>
+ c.text(openapiYaml, 200, {
+ "Content-Type": "application/yaml",
+ ...specHeaders,
+ }),
+);
+
+openapiRoute.get("/openapi.json", (c) =>
+ c.text(openapiJsonBody, 200, {
+ "Content-Type": "application/json",
+ ...specHeaders,
+ }),
+);
+
+openapiRoute.get("/openapi-v1.json", (c) =>
+ c.text(openapiV1JsonBody, 200, {
+ "Content-Type": "application/json",
+ ...specHeaders,
+ }),
+);
diff --git a/apps/server/static/openapi-yaml.ts b/apps/server/static/openapi-yaml.ts
new file mode 100644
index 000000000..ae05bc4fa
--- /dev/null
+++ b/apps/server/static/openapi-yaml.ts
@@ -0,0 +1,2 @@
+// Generated from openapi.yaml — run `pnpm --filter @openstatus/server openapi:json`.
+export default "openapi: 3.1.0\ninfo:\n description: OpenStatus is a open-source status page platform with global uptime monitoring. The OpenStatus API allows you to interact with the OpenStatus platform programmatically. To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings.\n title: OpenStatus API\n version: v2.0.0\n contact:\n email: [email protected]\n url: https://www.openstatus.dev\nservers:\n - url: https://api.openstatus.dev\n description: Production\nexternalDocs:\n description: OpenStatus Documentation\n url: https://www.openstatus.dev/docs\ncomponents:\n securitySchemes:\n ApiKeyAuth:\n type: apiKey\n in: header\n name: x-openstatus-key\n schemas:\n connect.error:\n type: object\n properties:\n code:\n type: string\n examples:\n - not_found\n enum:\n - canceled\n - unknown\n - invalid_argument\n - deadline_exceeded\n - not_found\n - already_exists\n - permission_denied\n - resource_exhausted\n - failed_precondition\n - aborted\n - out_of_range\n - unimplemented\n - internal\n - unavailable\n - data_loss\n - unauthenticated\n description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].\n message:\n type: string\n description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.\n details:\n type: array\n items:\n $ref: '#/components/schemas/connect.error_details.Any'\n description: A list of messages that carry the error details. There is no limit on the number of messages.\n title: Connect Error\n additionalProperties: true\n description: 'Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation'\n connect.error_details.Any:\n type: object\n properties:\n type:\n type: string\n description: 'A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field.'\n value:\n type: string\n format: binary\n description: The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field.\n debug:\n oneOf:\n - type: object\n title: Any\n additionalProperties: true\n description: Detailed error information.\n discriminator:\n propertyName: type\n title: Debug\n description: Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic.\n additionalProperties: true\n description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.\n openstatus.health.v1.CheckRequest:\n type: object\n properties:\n service:\n type: string\n title: service\n description: Optional service name to check. If empty, checks overall service health.\n title: CheckRequest\n additionalProperties: false\n description: CheckRequest is the request message for health checks.\n openstatus.health.v1.CheckResponse:\n type: object\n properties:\n status:\n title: status\n description: The serving status of the service.\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse.ServingStatus'\n title: CheckResponse\n additionalProperties: false\n description: CheckResponse is the response message for health checks.\n openstatus.health.v1.CheckResponse.ServingStatus:\n type: string\n title: ServingStatus\n enum:\n - SERVING_STATUS_UNSPECIFIED\n - SERVING_STATUS_SERVING\n - SERVING_STATUS_NOT_SERVING\n description: ServingStatus represents the health status of the service.\n openstatus.maintenance.v1.CreateMaintenanceRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - Database Migration\n title: title\n maxLength: 256\n minLength: 1\n description: Title of the maintenance (required, 1-256 characters).\n message:\n type: string\n title: message\n minLength: 1\n description: Message describing the maintenance (required).\n from:\n type: string\n examples:\n - \"2024-03-01T02:00:00Z\"\n title: from\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Start time of the maintenance window (RFC 3339 format, required).\n to:\n type: string\n examples:\n - \"2024-03-01T06:00:00Z\"\n title: to\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: End time of the maintenance window (RFC 3339 format, required).\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: Page ID to associate with this maintenance (required).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: Page component IDs to associate with this maintenance (optional).\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this maintenance (optional, defaults to false).\n title: CreateMaintenanceRequest\n additionalProperties: false\n description: CreateMaintenanceRequest is the request to create a new maintenance window.\n openstatus.maintenance.v1.CreateMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The created maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: CreateMaintenanceResponse\n additionalProperties: false\n description: CreateMaintenanceResponse is the response after creating a maintenance window.\n openstatus.maintenance.v1.DeleteMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to delete (required).\n title: DeleteMaintenanceRequest\n additionalProperties: false\n description: DeleteMaintenanceRequest is the request to delete a maintenance window.\n openstatus.maintenance.v1.DeleteMaintenanceResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteMaintenanceResponse\n additionalProperties: false\n description: DeleteMaintenanceResponse is the response after deleting a maintenance window.\n openstatus.maintenance.v1.GetMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to retrieve (required).\n title: GetMaintenanceRequest\n additionalProperties: false\n description: GetMaintenanceRequest is the request to get a maintenance window by ID.\n openstatus.maintenance.v1.GetMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The requested maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: GetMaintenanceResponse\n additionalProperties: false\n description: GetMaintenanceResponse is the response containing the maintenance window.\n openstatus.maintenance.v1.ListMaintenancesRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of maintenances to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of maintenances to skip for pagination (defaults to 0).\n pageId:\n type:\n - string\n - \"null\"\n title: page_id\n description: Filter by page ID (optional).\n title: ListMaintenancesRequest\n additionalProperties: false\n description: ListMaintenancesRequest is the request to list maintenance windows.\n openstatus.maintenance.v1.ListMaintenancesResponse:\n type: object\n properties:\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: List of maintenances.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of maintenances matching the filter.\n title: ListMaintenancesResponse\n additionalProperties: false\n description: ListMaintenancesResponse is the response containing maintenance window summaries.\n openstatus.maintenance.v1.Maintenance:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the maintenance.\n title:\n type: string\n title: title\n description: Title of the maintenance.\n message:\n type: string\n title: message\n description: Message describing the maintenance.\n from:\n type: string\n title: from\n description: Start time of the maintenance window (RFC 3339 format).\n to:\n type: string\n title: to\n description: End time of the maintenance window (RFC 3339 format).\n pageId:\n type: string\n title: page_id\n description: ID of the page this maintenance is associated with.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the maintenance was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the maintenance was last updated (RFC 3339 format).\n title: Maintenance\n additionalProperties: false\n description: Maintenance represents a maintenance window with full details.\n openstatus.maintenance.v1.MaintenanceSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the maintenance.\n title:\n type: string\n title: title\n description: Title of the maintenance.\n message:\n type: string\n title: message\n description: Message describing the maintenance.\n from:\n type: string\n title: from\n description: Start time of the maintenance window (RFC 3339 format).\n to:\n type: string\n title: to\n description: End time of the maintenance window (RFC 3339 format).\n pageId:\n type: string\n title: page_id\n description: ID of the page this maintenance is associated with.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the maintenance was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the maintenance was last updated (RFC 3339 format).\n title: MaintenanceSummary\n additionalProperties: false\n description: MaintenanceSummary represents metadata for a maintenance window (used in list responses).\n openstatus.maintenance.v1.UpdateMaintenanceRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the maintenance to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n maxLength: 256\n minLength: 1\n description: New title for the maintenance (optional).\n message:\n type:\n - string\n - \"null\"\n title: message\n description: New message for the maintenance (optional).\n from:\n type:\n - string\n - \"null\"\n title: from\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: New start time (RFC 3339 format, optional).\n to:\n type:\n - string\n - \"null\"\n title: to\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: New end time (RFC 3339 format, optional).\n pageId:\n type:\n - string\n - \"null\"\n title: page_id\n description: 'Deprecated: page_id is now derived from page_component_ids.'\n deprecated: true\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: New list of page component IDs (optional, replaces existing list).\n updatePageComponentIds:\n type:\n - boolean\n - \"null\"\n title: update_page_component_ids\n description: |-\n Set to true to update page component associations.\n When true, page_component_ids replaces the existing list (empty clears all).\n When false or unset, page_component_ids is ignored and existing associations are preserved.\n title: UpdateMaintenanceRequest\n additionalProperties: false\n description: UpdateMaintenanceRequest is the request to update a maintenance window.\n openstatus.maintenance.v1.UpdateMaintenanceResponse:\n type: object\n properties:\n maintenance:\n title: maintenance\n description: The updated maintenance.\n $ref: '#/components/schemas/openstatus.maintenance.v1.Maintenance'\n title: UpdateMaintenanceResponse\n additionalProperties: false\n description: UpdateMaintenanceResponse is the response after updating a maintenance window.\n openstatus.monitor.v1.BodyAssertion:\n type: object\n properties:\n target:\n type: string\n title: target\n description: Target value to compare against.\n comparator:\n not:\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.StringComparator'\n title: BodyAssertion\n additionalProperties: false\n description: BodyAssertion defines an assertion for response body content.\n openstatus.monitor.v1.CreateDNSMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: CreateDNSMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateDNSMonitorRequest is the request to create a new DNS monitor.\n openstatus.monitor.v1.CreateDNSMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: CreateDNSMonitorResponse\n additionalProperties: false\n description: CreateDNSMonitorResponse is the response after creating a DNS monitor.\n openstatus.monitor.v1.CreateGRPCMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: CreateGRPCMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateGRPCMonitorRequest is the request to create a new gRPC monitor.\n openstatus.monitor.v1.CreateGRPCMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: CreateGRPCMonitorResponse\n additionalProperties: false\n description: CreateGRPCMonitorResponse is the response after creating a gRPC monitor.\n openstatus.monitor.v1.CreateHTTPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: CreateHTTPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateHTTPMonitorRequest is the request to create a new HTTP monitor.\n openstatus.monitor.v1.CreateHTTPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: CreateHTTPMonitorResponse\n additionalProperties: false\n description: CreateHTTPMonitorResponse is the response after creating an HTTP monitor.\n openstatus.monitor.v1.CreateICMPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: CreateICMPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateICMPMonitorRequest is the request to create a new ICMP monitor.\n openstatus.monitor.v1.CreateICMPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: CreateICMPMonitorResponse\n additionalProperties: false\n description: CreateICMPMonitorResponse is the response after creating an ICMP monitor.\n openstatus.monitor.v1.CreateTCPMonitorRequest:\n type: object\n properties:\n monitor:\n title: monitor\n description: Monitor configuration (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: CreateTCPMonitorRequest\n required:\n - monitor\n additionalProperties: false\n description: CreateTCPMonitorRequest is the request to create a new TCP monitor.\n openstatus.monitor.v1.CreateTCPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The created monitor with assigned ID.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: CreateTCPMonitorResponse\n additionalProperties: false\n description: CreateTCPMonitorResponse is the response after creating a TCP monitor.\n openstatus.monitor.v1.DNSMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - DNS Resolution Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - example.com\n title: uri\n maxLength: 2048\n minLength: 1\n description: Domain to resolve (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n recordAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.RecordAssertion'\n title: record_assertions\n maxItems: 10\n description: DNS record assertions for validation.\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: DNSMonitor\n additionalProperties: false\n description: DNSMonitor defines the configuration for a DNS monitor.\n openstatus.monitor.v1.DeleteMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to delete (required).\n title: DeleteMonitorRequest\n additionalProperties: false\n description: DeleteMonitorRequest is the request to delete a monitor.\n openstatus.monitor.v1.DeleteMonitorResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteMonitorResponse\n additionalProperties: false\n description: DeleteMonitorResponse is the response after deleting a monitor.\n openstatus.monitor.v1.GRPCMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Checkout gRPC\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - api.example.com:443\n title: uri\n maxLength: 2048\n minLength: 1\n pattern: ^(\\[[0-9a-fA-F:]+\\]|[^:/\\s]+):[0-9]{1,5}$\n description: Target in \"host:port\" form. IPv6 addresses must be bracketed.\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n service:\n type:\n - string\n - \"null\"\n examples:\n - checkout.v1.CheckoutService\n title: service\n maxLength: 512\n description: Service name passed to Health/Check. Empty means overall server health.\n tlsMode:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.GRPCTlsMode'\n - type: \"null\"\n title: tls_mode\n description: How the connection to the target is secured. Defaults to TLS.\n metadata:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: metadata\n maxItems: 20\n description: Metadata sent with the health check request.\n title: GRPCMonitor\n additionalProperties: false\n description: |-\n GRPCMonitor defines the configuration for a gRPC health check monitor.\n The probe calls grpc.health.v1.Health/Check on the target.\n openstatus.monitor.v1.GRPCTlsMode:\n type: string\n title: GRPCTlsMode\n enum:\n - GRPC_TLS_MODE_UNSPECIFIED\n - GRPC_TLS_MODE_TLS\n - GRPC_TLS_MODE_PLAINTEXT\n - GRPC_TLS_MODE_TLS_INSECURE\n description: GRPCTlsMode selects how the probe secures its connection to the target.\n openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get a response log for (required).\n logId:\n type: string\n title: log_id\n minLength: 1\n description: Response log ID to retrieve (required).\n title: GetMonitorHTTPResponseLogRequest\n additionalProperties: false\n description: GetMonitorHTTPResponseLogRequest is the request to get one response log.\n openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse:\n type: object\n properties:\n log:\n title: log\n description: Response log details.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogDetail'\n title: GetMonitorHTTPResponseLogResponse\n additionalProperties: false\n description: GetMonitorHTTPResponseLogResponse is the response containing one response log.\n openstatus.monitor.v1.GetMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to retrieve (required).\n title: GetMonitorRequest\n additionalProperties: false\n description: GetMonitorRequest is the request to get a single monitor by ID.\n openstatus.monitor.v1.GetMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The monitor configuration (one of HTTP, TCP, DNS, ICMP, or gRPC).\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorConfig'\n title: GetMonitorResponse\n additionalProperties: false\n description: GetMonitorResponse is the response containing the monitor.\n openstatus.monitor.v1.GetMonitorStatusRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get status for (required).\n title: GetMonitorStatusRequest\n additionalProperties: false\n description: GetMonitorStatusRequest is the request to get the status of all regions for a monitor.\n openstatus.monitor.v1.GetMonitorStatusResponse:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Monitor ID.\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.RegionStatus'\n title: regions\n description: Status for each region.\n title: GetMonitorStatusResponse\n additionalProperties: false\n description: GetMonitorStatusResponse is the response containing the status of all regions for a monitor.\n openstatus.monitor.v1.GetMonitorSummaryRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to get summary for (required).\n timeRange:\n title: time_range\n description: Time range for metrics aggregation (defaults to 1 day if unspecified).\n $ref: '#/components/schemas/openstatus.monitor.v1.TimeRange'\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Optional filter by regions. If empty, returns metrics for all regions.\n title: GetMonitorSummaryRequest\n additionalProperties: false\n description: GetMonitorSummaryRequest is the request to get aggregated metrics for a monitor.\n openstatus.monitor.v1.GetMonitorSummaryResponse:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Monitor ID.\n lastPingAt:\n type: string\n title: last_ping_at\n description: Timestamp of the last check in RFC 3339 format.\n totalSuccessful:\n type:\n - integer\n - string\n title: total_successful\n format: int64\n description: Total number of successful requests.\n totalDegraded:\n type:\n - integer\n - string\n title: total_degraded\n format: int64\n description: Total number of degraded requests.\n totalFailed:\n type:\n - integer\n - string\n title: total_failed\n format: int64\n description: Total number of failed requests.\n p50:\n type:\n - integer\n - string\n title: p50\n format: int64\n description: 50th percentile (median) latency in milliseconds.\n p75:\n type:\n - integer\n - string\n title: p75\n format: int64\n description: 75th percentile latency in milliseconds.\n p90:\n type:\n - integer\n - string\n title: p90\n format: int64\n description: 90th percentile latency in milliseconds.\n p95:\n type:\n - integer\n - string\n title: p95\n format: int64\n description: 95th percentile latency in milliseconds.\n p99:\n type:\n - integer\n - string\n title: p99\n format: int64\n description: 99th percentile latency in milliseconds.\n timeRange:\n title: time_range\n description: Time range used for the metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.TimeRange'\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n description: Regions included in the metrics.\n title: GetMonitorSummaryResponse\n additionalProperties: false\n description: GetMonitorSummaryResponse is the response containing aggregated metrics for a monitor.\n openstatus.monitor.v1.HTTPMethod:\n type: string\n title: HTTPMethod\n enum:\n - HTTP_METHOD_UNSPECIFIED\n - HTTP_METHOD_GET\n - HTTP_METHOD_POST\n - HTTP_METHOD_HEAD\n - HTTP_METHOD_PUT\n - HTTP_METHOD_PATCH\n - HTTP_METHOD_DELETE\n - HTTP_METHOD_TRACE\n - HTTP_METHOD_CONNECT\n - HTTP_METHOD_OPTIONS\n description: HTTP methods supported for monitors.\n openstatus.monitor.v1.HTTPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Production API Health Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n url:\n type: string\n examples:\n - https://api.example.com/health\n title: url\n maxLength: 2048\n minLength: 1\n format: uri\n description: URL to monitor (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n method:\n not:\n enum:\n - HTTP_METHOD_UNSPECIFIED\n title: method\n description: HTTP method to use (defaults to GET).\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMethod'\n body:\n type: string\n examples:\n - map[key:value]\n title: body\n description: Request body (optional).\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n followRedirects:\n type:\n - boolean\n - \"null\"\n title: follow_redirects\n description: Whether to follow HTTP redirects (defaults to true when not specified).\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: headers\n maxItems: 20\n description: Custom headers for the request.\n statusCodeAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.StatusCodeAssertion'\n title: status_code_assertions\n maxItems: 10\n description: Status code assertions for the response.\n bodyAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.BodyAssertion'\n title: body_assertions\n maxItems: 10\n description: Body content assertions for the response.\n headerAssertions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HeaderAssertion'\n title: header_assertions\n maxItems: 10\n description: Header assertions for the response.\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: HTTPMonitor\n additionalProperties: false\n description: HTTPMonitor defines the configuration for an HTTP monitor.\n openstatus.monitor.v1.HTTPResponseLogDetail:\n type: object\n properties:\n log:\n title: log\n description: Compact response log fields.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem'\n url:\n type: string\n title: url\n description: Checked URL.\n error:\n type: boolean\n title: error\n description: Whether the check errored.\n message:\n type:\n - string\n - \"null\"\n title: message\n description: Error message, when present.\n headers:\n type: object\n title: headers\n additionalProperties:\n type: string\n title: value\n description: Redacted response headers.\n assertions:\n type:\n - string\n - \"null\"\n title: assertions\n description: Serialized assertions used for the check.\n title: HTTPResponseLogDetail\n additionalProperties: false\n description: HTTPResponseLogDetail contains full response log debugging data.\n openstatus.monitor.v1.HTTPResponseLogDetail.HeadersEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: HeadersEntry\n additionalProperties: false\n openstatus.monitor.v1.HTTPResponseLogListItem:\n type: object\n properties:\n id:\n type:\n - string\n - \"null\"\n title: id\n description: Response log ID.\n latency:\n type: integer\n title: latency\n format: int32\n description: Latency in milliseconds.\n statusCode:\n type:\n - integer\n - \"null\"\n title: status_code\n format: int32\n description: HTTP status code.\n monitorId:\n type: string\n title: monitor_id\n description: Monitor ID.\n requestStatus:\n title: request_status\n description: Request status classification.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogRequestStatus'\n region:\n title: region\n description: Region where the check ran.\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n cronTimestamp:\n type:\n - integer\n - string\n title: cron_timestamp\n format: int64\n description: Cron bucket timestamp in Unix milliseconds.\n trigger:\n title: trigger\n description: Check trigger.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTrigger'\n timestamp:\n type:\n - integer\n - string\n title: timestamp\n format: int64\n description: Response timestamp in Unix milliseconds.\n timing:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTiming'\n - type: \"null\"\n title: timing\n description: Timing phases.\n title: HTTPResponseLogListItem\n additionalProperties: false\n description: HTTPResponseLogListItem is a compact response log entry.\n openstatus.monitor.v1.HTTPResponseLogPagination:\n type: object\n properties:\n limit:\n type: integer\n title: limit\n format: int32\n description: Requested page size.\n offset:\n type: integer\n title: offset\n format: int32\n description: Requested offset.\n hasMore:\n type: boolean\n title: has_more\n description: Whether more logs are available.\n nextOffset:\n type:\n - integer\n - \"null\"\n title: next_offset\n format: int32\n description: Next offset if more logs are available.\n title: HTTPResponseLogPagination\n additionalProperties: false\n description: HTTPResponseLogPagination contains offset pagination metadata.\n openstatus.monitor.v1.HTTPResponseLogRequestStatus:\n type: string\n title: HTTPResponseLogRequestStatus\n enum:\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_UNSPECIFIED\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_SUCCESS\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_ERROR\n - HTTP_RESPONSE_LOG_REQUEST_STATUS_DEGRADED\n description: HTTPResponseLogRequestStatus is the result classification for an HTTP response log.\n openstatus.monitor.v1.HTTPResponseLogTiming:\n type: object\n properties:\n dns:\n type: integer\n title: dns\n format: int32\n description: DNS lookup duration.\n connect:\n type: integer\n title: connect\n format: int32\n description: TCP connection duration.\n tls:\n type: integer\n title: tls\n format: int32\n description: TLS handshake duration.\n ttfb:\n type: integer\n title: ttfb\n format: int32\n description: Time to first byte duration.\n transfer:\n type: integer\n title: transfer\n format: int32\n description: Response transfer duration.\n title: HTTPResponseLogTiming\n additionalProperties: false\n description: HTTPResponseLogTiming contains calculated timing phases in milliseconds.\n openstatus.monitor.v1.HTTPResponseLogTrigger:\n type: string\n title: HTTPResponseLogTrigger\n enum:\n - HTTP_RESPONSE_LOG_TRIGGER_UNSPECIFIED\n - HTTP_RESPONSE_LOG_TRIGGER_CRON\n - HTTP_RESPONSE_LOG_TRIGGER_API\n description: HTTPResponseLogTrigger describes what started the monitor check.\n openstatus.monitor.v1.HeaderAssertion:\n type: object\n properties:\n target:\n type: string\n title: target\n description: Target value to compare against.\n comparator:\n not:\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.StringComparator'\n key:\n type: string\n title: key\n minLength: 1\n description: Header key to check (required).\n title: HeaderAssertion\n additionalProperties: false\n description: HeaderAssertion defines an assertion for response headers.\n openstatus.monitor.v1.Headers:\n type: object\n properties:\n key:\n type: string\n examples:\n - Authorization\n title: key\n minLength: 1\n description: Header name.\n value:\n type: string\n examples:\n - Bearer token123\n title: value\n description: Header value.\n title: Headers\n additionalProperties: false\n description: Headers represents a key-value pair for HTTP headers.\n openstatus.monitor.v1.ICMPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Ping Gateway\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - 1.1.1.1\n title: uri\n maxLength: 2048\n minLength: 1\n description: URI to monitor in format \"host or IP\" (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: ICMPMonitor\n additionalProperties: false\n description: ICMPMonitor defines the configuration for a ICMP monitor.\n openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to list response logs for (required).\n fromTimestamp:\n type:\n - integer\n - string\n - \"null\"\n title: from_timestamp\n format: int64\n description: Start of the response log window as Unix milliseconds within the 14-day retention window.\n toTimestamp:\n type:\n - integer\n - string\n - \"null\"\n title: to_timestamp\n format: int64\n description: End of the response log window as Unix milliseconds within the 14-day retention window.\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of logs to return (1-100, defaults to 25).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of logs to skip for pagination (defaults to 0).\n title: ListMonitorHTTPResponseLogsRequest\n additionalProperties: false\n description: ListMonitorHTTPResponseLogsRequest is the request to list response logs within the 14-day HTTP response-log window.\n openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse:\n type: object\n properties:\n logs:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem'\n title: logs\n description: Response logs.\n pagination:\n title: pagination\n description: Pagination metadata.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPResponseLogPagination'\n title: ListMonitorHTTPResponseLogsResponse\n additionalProperties: false\n description: ListMonitorHTTPResponseLogsResponse is the response containing response logs.\n openstatus.monitor.v1.ListMonitorsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of monitors to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of monitors to skip for pagination (defaults to 0).\n title: ListMonitorsRequest\n additionalProperties: false\n description: ListMonitorsRequest is the request to list monitors.\n openstatus.monitor.v1.ListMonitorsResponse:\n type: object\n properties:\n httpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: http_monitors\n description: HTTP monitors in the workspace.\n tcpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: tcp_monitors\n description: TCP monitors in the workspace.\n dnsMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: dns_monitors\n description: DNS monitors in the workspace.\n icmpMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: icmp_monitors\n description: ICMP monitors in the workspace.\n grpcMonitors:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: grpc_monitors\n description: gRPC monitors in the workspace.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of monitors across all types.\n title: ListMonitorsResponse\n additionalProperties: false\n description: ListMonitorsResponse is the response containing a list of monitors.\n openstatus.monitor.v1.MonitorConfig:\n type: object\n oneOf:\n - type: object\n properties:\n dns:\n title: dns\n description: DNS monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: dns\n required:\n - dns\n - type: object\n properties:\n grpc:\n title: grpc\n description: gRPC monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: grpc\n required:\n - grpc\n - type: object\n properties:\n http:\n title: http\n description: HTTP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: http\n required:\n - http\n - type: object\n properties:\n icmp:\n title: icmp\n description: ICMP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: icmp\n required:\n - icmp\n - type: object\n properties:\n tcp:\n title: tcp\n description: TCP monitor configuration.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: tcp\n required:\n - tcp\n title: MonitorConfig\n additionalProperties: false\n description: MonitorConfig represents the type-specific configuration for a monitor.\n openstatus.monitor.v1.MonitorStatus:\n type: string\n title: MonitorStatus\n enum:\n - MONITOR_STATUS_UNSPECIFIED\n - MONITOR_STATUS_ACTIVE\n - MONITOR_STATUS_DEGRADED\n - MONITOR_STATUS_ERROR\n description: MonitorStatus represents the operational status of a monitor.\n openstatus.monitor.v1.NumberComparator:\n type: string\n title: NumberComparator\n enum:\n - NUMBER_COMPARATOR_UNSPECIFIED\n - NUMBER_COMPARATOR_EQUAL\n - NUMBER_COMPARATOR_NOT_EQUAL\n - NUMBER_COMPARATOR_GREATER_THAN\n - NUMBER_COMPARATOR_GREATER_THAN_OR_EQUAL\n - NUMBER_COMPARATOR_LESS_THAN\n - NUMBER_COMPARATOR_LESS_THAN_OR_EQUAL\n description: NumberComparator defines comparison operations for numeric values.\n openstatus.monitor.v1.OpenTelemetryConfig:\n type: object\n properties:\n endpoint:\n type: string\n title: endpoint\n maxLength: 2048\n description: OTEL endpoint URL.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Headers'\n title: headers\n maxItems: 20\n description: Custom headers for OTEL requests.\n title: OpenTelemetryConfig\n additionalProperties: false\n description: OpenTelemetry configuration for exporting metrics.\n openstatus.monitor.v1.Periodicity:\n type: string\n title: Periodicity\n enum:\n - PERIODICITY_UNSPECIFIED\n - PERIODICITY_30S\n - PERIODICITY_1M\n - PERIODICITY_5M\n - PERIODICITY_10M\n - PERIODICITY_30M\n - PERIODICITY_1H\n description: Monitor periodicity options.\n openstatus.monitor.v1.RecordAssertion:\n type: object\n properties:\n record:\n type: string\n title: record\n enum:\n - A\n - AAAA\n - CNAME\n - MX\n - TXT\n description: DNS record type (e.g., \"A\", \"AAAA\", \"CNAME\", \"MX\", \"TXT\").\n comparator:\n not:\n enum:\n - RECORD_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.RecordComparator'\n target:\n type: string\n title: target\n description: Target value to compare against.\n title: RecordAssertion\n additionalProperties: false\n description: RecordAssertion defines an assertion for DNS records.\n openstatus.monitor.v1.RecordComparator:\n type: string\n title: RecordComparator\n enum:\n - RECORD_COMPARATOR_UNSPECIFIED\n - RECORD_COMPARATOR_EQUAL\n - RECORD_COMPARATOR_NOT_EQUAL\n - RECORD_COMPARATOR_CONTAINS\n - RECORD_COMPARATOR_NOT_CONTAINS\n description: RecordComparator defines comparison operations for DNS records.\n openstatus.monitor.v1.Region:\n type: string\n title: Region\n enum:\n - REGION_UNSPECIFIED\n - REGION_FLY_AMS\n - REGION_FLY_ARN\n - REGION_FLY_BOM\n - REGION_FLY_CDG\n - REGION_FLY_DFW\n - REGION_FLY_EWR\n - REGION_FLY_FRA\n - REGION_FLY_GRU\n - REGION_FLY_IAD\n - REGION_FLY_JNB\n - REGION_FLY_LAX\n - REGION_FLY_LHR\n - REGION_FLY_NRT\n - REGION_FLY_ORD\n - REGION_FLY_SJC\n - REGION_FLY_SIN\n - REGION_FLY_SYD\n - REGION_FLY_YYZ\n - REGION_KOYEB_FRA\n - REGION_KOYEB_PAR\n - REGION_KOYEB_SFO\n - REGION_KOYEB_SIN\n - REGION_KOYEB_TYO\n - REGION_KOYEB_WAS\n - REGION_RAILWAY_US_WEST2\n - REGION_RAILWAY_US_EAST4\n - REGION_RAILWAY_EUROPE_WEST4\n - REGION_RAILWAY_ASIA_SOUTHEAST1\n description: Geographic regions where monitors can run checks from.\n openstatus.monitor.v1.RegionStatus:\n type: object\n properties:\n region:\n title: region\n description: The region identifier.\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n status:\n title: status\n description: The status of the monitor in this region.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n title: RegionStatus\n additionalProperties: false\n description: RegionStatus represents the status of a monitor in a specific region.\n openstatus.monitor.v1.StatusCodeAssertion:\n type: object\n properties:\n target:\n type:\n - integer\n - string\n title: target\n maximum: 599\n minimum: 100\n format: int64\n description: Target status code to compare against (100-599).\n comparator:\n not:\n enum:\n - NUMBER_COMPARATOR_UNSPECIFIED\n title: comparator\n description: Comparison operation (required, must not be UNSPECIFIED).\n $ref: '#/components/schemas/openstatus.monitor.v1.NumberComparator'\n title: StatusCodeAssertion\n additionalProperties: false\n description: StatusCodeAssertion defines an assertion for HTTP status codes.\n openstatus.monitor.v1.StringComparator:\n type: string\n title: StringComparator\n enum:\n - STRING_COMPARATOR_UNSPECIFIED\n - STRING_COMPARATOR_CONTAINS\n - STRING_COMPARATOR_NOT_CONTAINS\n - STRING_COMPARATOR_EQUAL\n - STRING_COMPARATOR_NOT_EQUAL\n - STRING_COMPARATOR_EMPTY\n - STRING_COMPARATOR_NOT_EMPTY\n - STRING_COMPARATOR_GREATER_THAN\n - STRING_COMPARATOR_GREATER_THAN_OR_EQUAL\n - STRING_COMPARATOR_LESS_THAN\n - STRING_COMPARATOR_LESS_THAN_OR_EQUAL\n description: StringComparator defines comparison operations for string values.\n openstatus.monitor.v1.TCPMonitor:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the monitor (output only for create requests).\n name:\n type: string\n examples:\n - Database Connection Check\n title: name\n maxLength: 256\n minLength: 1\n description: Name of the monitor (required, max 256 characters).\n uri:\n type: string\n examples:\n - tcp://db.example.com:5432\n title: uri\n maxLength: 2048\n minLength: 1\n description: URI to monitor in format \"host:port\" (required, max 2048 characters).\n periodicity:\n not:\n enum:\n - PERIODICITY_UNSPECIFIED\n title: periodicity\n description: Check periodicity (required).\n $ref: '#/components/schemas/openstatus.monitor.v1.Periodicity'\n timeout:\n type:\n - integer\n - string\n title: timeout\n maximum: 120000\n minimum: 0\n format: int64\n description: Timeout in milliseconds (0-120000, defaults to 45000).\n degradedAt:\n type:\n - integer\n - string\n - \"null\"\n title: degraded_at\n maximum: 120000\n minimum: 0\n format: int64\n description: Latency threshold for degraded status in milliseconds (optional, 0-120000).\n retry:\n type:\n - integer\n - string\n title: retry\n maximum: 10\n minimum: 0\n format: int64\n description: Number of retry attempts (0-10, defaults to 3).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the monitor (optional).\n active:\n type:\n - boolean\n - \"null\"\n title: active\n description: Whether the monitor is active (defaults to false).\n public:\n type:\n - boolean\n - \"null\"\n title: public\n description: Whether the monitor is publicly visible (defaults to false).\n regions:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.monitor.v1.Region'\n title: regions\n maxItems: 28\n description: Geographic regions to run checks from.\n openTelemetry:\n title: open_telemetry\n description: OpenTelemetry configuration for exporting metrics.\n $ref: '#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig'\n status:\n title: status\n description: Current operational status of the monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.MonitorStatus'\n privateLocationIds:\n type: array\n items:\n type: string\n readOnly: true\n title: private_location_ids\n description: IDs of private locations that run this monitor. Read-only.\n readOnly: true\n title: TCPMonitor\n additionalProperties: false\n description: TCPMonitor defines the configuration for a TCP monitor.\n openstatus.monitor.v1.TimeRange:\n type: string\n title: TimeRange\n enum:\n - TIME_RANGE_UNSPECIFIED\n - TIME_RANGE_1D\n - TIME_RANGE_7D\n - TIME_RANGE_14D\n description: TimeRange represents the time period for metrics aggregation.\n openstatus.monitor.v1.TriggerMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to trigger (required).\n title: TriggerMonitorRequest\n additionalProperties: false\n description: TriggerMonitorRequest is the request to trigger a monitor check.\n openstatus.monitor.v1.TriggerMonitorResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the trigger was successful.\n title: TriggerMonitorResponse\n additionalProperties: false\n description: TriggerMonitorResponse is the response after triggering a monitor.\n openstatus.monitor.v1.UpdateDNSMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateDNSMonitorRequest\n additionalProperties: false\n description: UpdateDNSMonitorRequest is the request to update an existing DNS monitor.\n openstatus.monitor.v1.UpdateDNSMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.DNSMonitor'\n title: UpdateDNSMonitorResponse\n additionalProperties: false\n description: UpdateDNSMonitorResponse is the response after updating a DNS monitor.\n openstatus.monitor.v1.UpdateGRPCMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateGRPCMonitorRequest\n additionalProperties: false\n description: UpdateGRPCMonitorRequest is the request to update an existing gRPC monitor.\n openstatus.monitor.v1.UpdateGRPCMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.GRPCMonitor'\n title: UpdateGRPCMonitorResponse\n additionalProperties: false\n description: UpdateGRPCMonitorResponse is the response after updating a gRPC monitor.\n openstatus.monitor.v1.UpdateHTTPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateHTTPMonitorRequest\n additionalProperties: false\n description: UpdateHTTPMonitorRequest is the request to update an existing HTTP monitor.\n openstatus.monitor.v1.UpdateHTTPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.HTTPMonitor'\n title: UpdateHTTPMonitorResponse\n additionalProperties: false\n description: UpdateHTTPMonitorResponse is the response after updating an HTTP monitor.\n openstatus.monitor.v1.UpdateICMPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateICMPMonitorRequest\n additionalProperties: false\n description: UpdateICMPMonitorRequest is the request to update an existing ICMP monitor.\n openstatus.monitor.v1.UpdateICMPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.ICMPMonitor'\n title: UpdateICMPMonitorResponse\n additionalProperties: false\n description: UpdateICMPMonitorResponse is the response after updating an ICMP monitor.\n openstatus.monitor.v1.UpdateTCPMonitorRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Monitor ID to update (required).\n monitor:\n oneOf:\n - $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n - type: \"null\"\n title: monitor\n description: Updated monitor configuration (all fields optional for partial updates).\n title: UpdateTCPMonitorRequest\n additionalProperties: false\n description: UpdateTCPMonitorRequest is the request to update an existing TCP monitor.\n openstatus.monitor.v1.UpdateTCPMonitorResponse:\n type: object\n properties:\n monitor:\n title: monitor\n description: The updated monitor.\n $ref: '#/components/schemas/openstatus.monitor.v1.TCPMonitor'\n title: UpdateTCPMonitorResponse\n additionalProperties: false\n description: UpdateTCPMonitorResponse is the response after updating a TCP monitor.\n openstatus.notification.v1.CheckNotificationLimitRequest:\n type: object\n title: CheckNotificationLimitRequest\n additionalProperties: false\n description: CheckNotificationLimitRequest is the request to check notification limits.\n openstatus.notification.v1.CheckNotificationLimitResponse:\n type: object\n properties:\n limitReached:\n type: boolean\n title: limit_reached\n description: Whether the workspace has reached its notification limit.\n currentCount:\n type: integer\n title: current_count\n format: int32\n description: Current number of notification channels.\n maxCount:\n type: integer\n title: max_count\n format: int32\n description: Maximum allowed notification channels.\n title: CheckNotificationLimitResponse\n additionalProperties: false\n description: CheckNotificationLimitResponse is the response containing limit information.\n openstatus.notification.v1.CreateNotificationRequest:\n type: object\n properties:\n name:\n type: string\n examples:\n - Slack Ops Channel\n title: name\n minLength: 1\n description: Display name for the notification channel.\n provider:\n not:\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors to associate with this notification.\n title: CreateNotificationRequest\n required:\n - data\n additionalProperties: false\n description: CreateNotificationRequest is the request to create a new notification channel.\n openstatus.notification.v1.CreateNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The created notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: CreateNotificationResponse\n additionalProperties: false\n description: CreateNotificationResponse is the response after creating a notification channel.\n openstatus.notification.v1.DeleteNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to delete (required).\n title: DeleteNotificationRequest\n additionalProperties: false\n description: DeleteNotificationRequest is the request to delete a notification channel.\n openstatus.notification.v1.DeleteNotificationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteNotificationResponse\n additionalProperties: false\n description: DeleteNotificationResponse is the response after deleting a notification channel.\n openstatus.notification.v1.DiscordData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://discord.com/api/webhooks/123/abc\n title: webhook_url\n format: uri\n description: Discord webhook URL.\n title: DiscordData\n additionalProperties: false\n description: DiscordData contains configuration for Discord notifications.\n openstatus.notification.v1.EmailData:\n type: object\n properties:\n email:\n type: string\n examples:\n - [email protected]\n title: email\n format: email\n description: Email address to send notifications to.\n title: EmailData\n additionalProperties: false\n description: EmailData contains configuration for email notifications.\n openstatus.notification.v1.GetNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to retrieve (required).\n title: GetNotificationRequest\n additionalProperties: false\n description: GetNotificationRequest is the request to get a notification channel.\n openstatus.notification.v1.GetNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: GetNotificationResponse\n additionalProperties: false\n description: GetNotificationResponse is the response containing the notification channel.\n openstatus.notification.v1.GoogleChatData:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n format: uri\n description: Google Chat webhook URL.\n title: GoogleChatData\n additionalProperties: false\n description: GoogleChatData contains configuration for Google Chat notifications.\n openstatus.notification.v1.GrafanaOncallData:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n format: uri\n description: Grafana OnCall webhook URL.\n title: GrafanaOncallData\n additionalProperties: false\n description: GrafanaOncallData contains configuration for Grafana OnCall notifications.\n openstatus.notification.v1.ListNotificationsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of notifications to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of notifications to skip for pagination (defaults to 0).\n title: ListNotificationsRequest\n additionalProperties: false\n description: ListNotificationsRequest is the request to list notification channels.\n openstatus.notification.v1.ListNotificationsResponse:\n type: object\n properties:\n notifications:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationSummary'\n title: notifications\n description: Notification channel summaries.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of notification channels.\n title: ListNotificationsResponse\n additionalProperties: false\n description: ListNotificationsResponse is the response containing notification channels.\n openstatus.notification.v1.MsTeamsData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://prod-00.westeurope.logic.azure.com:443/workflows/abc/triggers/manual/paths/invoke\n title: webhook_url\n format: uri\n description: Microsoft Teams webhook URL (Power Automate Workflows).\n title: MsTeamsData\n additionalProperties: false\n description: MsTeamsData contains configuration for Microsoft Teams notifications.\n openstatus.notification.v1.Notification:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the notification.\n name:\n type: string\n title: name\n description: Display name for the notification channel.\n provider:\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors associated with this notification.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the notification was created (RFC 3339).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the notification was last updated (RFC 3339).\n title: Notification\n additionalProperties: false\n description: Notification represents a notification channel with full details.\n openstatus.notification.v1.NotificationData:\n type: object\n oneOf:\n - type: object\n properties:\n discord:\n title: discord\n description: Discord configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.DiscordData'\n title: discord\n required:\n - discord\n - type: object\n properties:\n email:\n title: email\n description: Email configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.EmailData'\n title: email\n required:\n - email\n - type: object\n properties:\n googleChat:\n title: google_chat\n description: Google Chat configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.GoogleChatData'\n title: google_chat\n required:\n - googleChat\n - type: object\n properties:\n grafanaOncall:\n title: grafana_oncall\n description: Grafana OnCall configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.GrafanaOncallData'\n title: grafana_oncall\n required:\n - grafanaOncall\n - type: object\n properties:\n msTeams:\n title: ms_teams\n description: Microsoft Teams configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.MsTeamsData'\n title: ms_teams\n required:\n - msTeams\n - type: object\n properties:\n ntfy:\n title: ntfy\n description: Ntfy configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NtfyData'\n title: ntfy\n required:\n - ntfy\n - type: object\n properties:\n opsgenie:\n title: opsgenie\n description: Opsgenie configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.OpsgenieData'\n title: opsgenie\n required:\n - opsgenie\n - type: object\n properties:\n pagerduty:\n title: pagerduty\n description: PagerDuty configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.PagerDutyData'\n title: pagerduty\n required:\n - pagerduty\n - type: object\n properties:\n slack:\n title: slack\n description: Slack configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.SlackData'\n title: slack\n required:\n - slack\n - type: object\n properties:\n sms:\n title: sms\n description: SMS configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.SmsData'\n title: sms\n required:\n - sms\n - type: object\n properties:\n telegram:\n title: telegram\n description: Telegram configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.TelegramData'\n title: telegram\n required:\n - telegram\n - type: object\n properties:\n webhook:\n title: webhook\n description: Webhook configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.WebhookData'\n title: webhook\n required:\n - webhook\n - type: object\n properties:\n whatsapp:\n title: whatsapp\n description: WhatsApp configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.WhatsappData'\n title: whatsapp\n required:\n - whatsapp\n title: NotificationData\n additionalProperties: false\n description: NotificationData is a union of provider-specific configuration.\n openstatus.notification.v1.NotificationProvider:\n type: string\n title: NotificationProvider\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n - NOTIFICATION_PROVIDER_DISCORD\n - NOTIFICATION_PROVIDER_EMAIL\n - NOTIFICATION_PROVIDER_GOOGLE_CHAT\n - NOTIFICATION_PROVIDER_GRAFANA_ONCALL\n - NOTIFICATION_PROVIDER_NTFY\n - NOTIFICATION_PROVIDER_PAGERDUTY\n - NOTIFICATION_PROVIDER_OPSGENIE\n - NOTIFICATION_PROVIDER_SLACK\n - NOTIFICATION_PROVIDER_SMS\n - NOTIFICATION_PROVIDER_TELEGRAM\n - NOTIFICATION_PROVIDER_WEBHOOK\n - NOTIFICATION_PROVIDER_WHATSAPP\n - NOTIFICATION_PROVIDER_MS_TEAMS\n description: NotificationProvider represents the supported notification channel types.\n openstatus.notification.v1.NotificationSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the notification.\n name:\n type: string\n title: name\n description: Display name for the notification channel.\n provider:\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n monitorCount:\n type: integer\n title: monitor_count\n format: int32\n description: Number of monitors associated with this notification.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the notification was created (RFC 3339).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the notification was last updated (RFC 3339).\n title: NotificationSummary\n additionalProperties: false\n description: NotificationSummary represents a notification channel summary for list responses.\n openstatus.notification.v1.NtfyData:\n type: object\n properties:\n topic:\n type: string\n examples:\n - openstatus-alerts\n title: topic\n minLength: 1\n description: Ntfy topic to publish to.\n serverUrl:\n type: string\n title: server_url\n description: Ntfy server URL (defaults to https://ntfy.sh).\n token:\n type:\n - string\n - \"null\"\n title: token\n description: Optional authentication token.\n title: NtfyData\n additionalProperties: false\n description: NtfyData contains configuration for Ntfy notifications.\n openstatus.notification.v1.OpsgenieData:\n type: object\n properties:\n apiKey:\n type: string\n title: api_key\n minLength: 1\n description: Opsgenie API key.\n region:\n title: region\n description: Opsgenie region.\n $ref: '#/components/schemas/openstatus.notification.v1.OpsgenieRegion'\n title: OpsgenieData\n additionalProperties: false\n description: OpsgenieData contains configuration for Opsgenie notifications.\n openstatus.notification.v1.OpsgenieRegion:\n type: string\n title: OpsgenieRegion\n enum:\n - OPSGENIE_REGION_UNSPECIFIED\n - OPSGENIE_REGION_US\n - OPSGENIE_REGION_EU\n description: OpsgenieRegion represents the Opsgenie API region.\n openstatus.notification.v1.PagerDutyData:\n type: object\n properties:\n integrationKey:\n type: string\n examples:\n - a1b2c3d4e5f6g7h8i9j0\n title: integration_key\n minLength: 1\n description: PagerDuty integration key.\n title: PagerDutyData\n additionalProperties: false\n description: PagerDutyData contains configuration for PagerDuty notifications.\n openstatus.notification.v1.SendTestNotificationRequest:\n type: object\n properties:\n provider:\n not:\n enum:\n - NOTIFICATION_PROVIDER_UNSPECIFIED\n title: provider\n description: Provider type.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationProvider'\n data:\n title: data\n description: Provider-specific configuration.\n $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n title: SendTestNotificationRequest\n required:\n - data\n additionalProperties: false\n description: SendTestNotificationRequest is the request to send a test notification.\n openstatus.notification.v1.SendTestNotificationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the test was successful.\n errorMessage:\n type:\n - string\n - \"null\"\n title: error_message\n description: Optional error message if the test failed.\n title: SendTestNotificationResponse\n additionalProperties: false\n description: SendTestNotificationResponse is the response after sending a test notification.\n openstatus.notification.v1.SlackData:\n type: object\n properties:\n webhookUrl:\n type: string\n examples:\n - https://hooks.slack.com/services/T00/B00/xxx\n title: webhook_url\n format: uri\n description: Slack webhook URL.\n title: SlackData\n additionalProperties: false\n description: SlackData contains configuration for Slack notifications.\n openstatus.notification.v1.SmsData:\n type: object\n properties:\n phoneNumber:\n type: string\n examples:\n - \"+14155551234\"\n title: phone_number\n minLength: 1\n description: Phone number to send SMS to.\n title: SmsData\n additionalProperties: false\n description: SmsData contains configuration for SMS notifications.\n openstatus.notification.v1.TelegramData:\n type: object\n properties:\n chatId:\n type: string\n examples:\n - \"-1001234567890\"\n title: chat_id\n minLength: 1\n description: Telegram chat ID.\n title: TelegramData\n additionalProperties: false\n description: TelegramData contains configuration for Telegram notifications.\n openstatus.notification.v1.UpdateNotificationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: Notification ID to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n description: Updated display name.\n data:\n oneOf:\n - $ref: '#/components/schemas/openstatus.notification.v1.NotificationData'\n - type: \"null\"\n title: data\n description: Updated provider-specific configuration.\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: Updated monitor IDs to associate.\n updateMonitorIds:\n type:\n - boolean\n - \"null\"\n title: update_monitor_ids\n description: |-\n Set to true to update monitor associations.\n When true, monitor_ids replaces the existing list (empty clears all).\n When false or unset, monitor_ids is ignored and existing associations are preserved.\n title: UpdateNotificationRequest\n additionalProperties: false\n description: UpdateNotificationRequest is the request to update a notification channel.\n openstatus.notification.v1.UpdateNotificationResponse:\n type: object\n properties:\n notification:\n title: notification\n description: The updated notification channel.\n $ref: '#/components/schemas/openstatus.notification.v1.Notification'\n title: UpdateNotificationResponse\n additionalProperties: false\n description: UpdateNotificationResponse is the response after updating a notification channel.\n openstatus.notification.v1.WebhookData:\n type: object\n properties:\n endpoint:\n type: string\n examples:\n - https://api.example.com/webhooks/openstatus\n title: endpoint\n format: uri\n description: Webhook endpoint URL.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.notification.v1.WebhookHeader'\n title: headers\n description: Optional custom headers.\n title: WebhookData\n additionalProperties: false\n description: WebhookData contains configuration for custom webhook notifications.\n openstatus.notification.v1.WebhookHeader:\n type: object\n properties:\n key:\n type: string\n title: key\n minLength: 1\n description: Header name.\n value:\n type: string\n title: value\n description: Header value.\n title: WebhookHeader\n additionalProperties: false\n description: WebhookHeader represents a custom header for webhook requests.\n openstatus.notification.v1.WhatsappData:\n type: object\n properties:\n phoneNumber:\n type: string\n title: phone_number\n minLength: 1\n description: Phone number to send WhatsApp messages to.\n title: WhatsappData\n additionalProperties: false\n description: WhatsappData contains configuration for WhatsApp notifications.\n openstatus.private_location.v1.CreatePrivateLocationRequest:\n type: object\n properties:\n name:\n type: string\n examples:\n - eu-west-agent\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the private location (required, 1-256 characters).\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors this private location should run (optional).\n metadata:\n type: object\n title: metadata\n maxProperties: 20\n additionalProperties:\n type: string\n title: value\n maxLength: 256\n description: User-defined key/value labels (optional, up to 20 entries).\n title: CreatePrivateLocationRequest\n additionalProperties: false\n description: CreatePrivateLocationRequest is the request to create a new private location.\n openstatus.private_location.v1.CreatePrivateLocationRequest.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.CreatePrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The created private location, including its generated agent token.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: CreatePrivateLocationResponse\n additionalProperties: false\n description: CreatePrivateLocationResponse is the response after creating a private location.\n openstatus.private_location.v1.DeletePrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to delete (required).\n title: DeletePrivateLocationRequest\n additionalProperties: false\n description: DeletePrivateLocationRequest is the request to delete a private location.\n openstatus.private_location.v1.DeletePrivateLocationResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeletePrivateLocationResponse\n additionalProperties: false\n description: DeletePrivateLocationResponse is the response after deleting a private location.\n openstatus.private_location.v1.GetPrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to retrieve (required).\n title: GetPrivateLocationRequest\n additionalProperties: false\n description: GetPrivateLocationRequest is the request to get a private location by ID.\n openstatus.private_location.v1.GetPrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The requested private location.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: GetPrivateLocationResponse\n additionalProperties: false\n description: GetPrivateLocationResponse is the response containing the private location.\n openstatus.private_location.v1.ListPrivateLocationsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of private locations to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of private locations to skip for pagination (defaults to 0).\n title: ListPrivateLocationsRequest\n additionalProperties: false\n description: ListPrivateLocationsRequest is the request to list private locations.\n openstatus.private_location.v1.ListPrivateLocationsResponse:\n type: object\n properties:\n privateLocations:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationSummary'\n title: private_locations\n description: List of private locations.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of private locations in the workspace.\n title: ListPrivateLocationsResponse\n additionalProperties: false\n description: ListPrivateLocationsResponse is the response containing private location summaries.\n openstatus.private_location.v1.PrivateLocation:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the private location.\n name:\n type: string\n title: name\n description: Display name for the private location.\n token:\n type: string\n title: token\n description: |-\n Agent credential. Generated by the server on creation and used by the\n agent to authenticate; treat it as a secret.\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: IDs of monitors this private location runs.\n lastSeenAt:\n type: string\n title: last_seen_at\n description: Last time the agent reported a result (RFC 3339), empty if it never has.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the private location was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the private location was last updated (RFC 3339 format).\n metadata:\n type: object\n title: metadata\n additionalProperties:\n type: string\n title: value\n description: User-defined key/value labels attached to this private location.\n status:\n title: status\n description: Computed health of the agent. Read-only.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus'\n title: PrivateLocation\n additionalProperties: false\n description: PrivateLocation represents a self-hosted checker agent with full details.\n openstatus.private_location.v1.PrivateLocation.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.PrivateLocationStatus:\n type: string\n title: PrivateLocationStatus\n enum:\n - PRIVATE_LOCATION_STATUS_UNSPECIFIED\n - PRIVATE_LOCATION_STATUS_ACTIVE\n - PRIVATE_LOCATION_STATUS_ERROR\n description: |-\n PrivateLocationStatus is the computed health of a private location, derived\n from the agent heartbeat. Read-only — it cannot be set through the API.\n openstatus.private_location.v1.PrivateLocationSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the private location.\n name:\n type: string\n title: name\n description: Display name for the private location.\n monitorCount:\n type: integer\n title: monitor_count\n format: int32\n description: Number of monitors this private location runs.\n lastSeenAt:\n type: string\n title: last_seen_at\n description: Last time the agent reported a result (RFC 3339), empty if it never has.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the private location was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the private location was last updated (RFC 3339 format).\n status:\n title: status\n description: Computed health of the agent. Read-only.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus'\n metadata:\n type: object\n title: metadata\n additionalProperties:\n type: string\n title: value\n description: User-defined key/value labels attached to this private location.\n title: PrivateLocationSummary\n additionalProperties: false\n description: |-\n PrivateLocationSummary represents metadata for a private location (used in\n list responses). The agent token is intentionally omitted.\n openstatus.private_location.v1.PrivateLocationSummary.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.UpdatePrivateLocationRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the private location to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n minLength: 1\n description: New display name for the private location (optional).\n monitorIds:\n type: array\n items:\n type: string\n title: monitor_ids\n description: New list of monitor IDs. Only applied when update_monitor_ids is true.\n updateMonitorIds:\n type:\n - boolean\n - \"null\"\n title: update_monitor_ids\n description: |-\n When true, monitor_ids replaces the current associations (an empty list\n clears all). When false or unset, monitor_ids is ignored and existing\n associations are preserved.\n metadata:\n type: object\n title: metadata\n maxProperties: 20\n additionalProperties:\n type: string\n title: value\n maxLength: 256\n description: New key/value labels. Only applied when update_metadata is true.\n updateMetadata:\n type:\n - boolean\n - \"null\"\n title: update_metadata\n description: |-\n When true, metadata replaces the current labels (an empty map clears all).\n When false or unset, metadata is ignored and existing labels are preserved.\n title: UpdatePrivateLocationRequest\n additionalProperties: false\n description: UpdatePrivateLocationRequest is the request to update a private location.\n openstatus.private_location.v1.UpdatePrivateLocationRequest.MetadataEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: MetadataEntry\n additionalProperties: false\n openstatus.private_location.v1.UpdatePrivateLocationResponse:\n type: object\n properties:\n privateLocation:\n title: private_location\n description: The updated private location.\n $ref: '#/components/schemas/openstatus.private_location.v1.PrivateLocation'\n title: UpdatePrivateLocationResponse\n additionalProperties: false\n description: UpdatePrivateLocationResponse is the response after updating a private location.\n openstatus.status_page.v1.AddMonitorComponentRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to add the component to (required).\n monitorId:\n type: string\n title: monitor_id\n minLength: 1\n description: ID of the monitor to associate with this component (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n description: Display name for the component (optional, defaults to monitor name).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: Display order of the component (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: ID of the group to add this component to (optional).\n title: AddMonitorComponentRequest\n additionalProperties: false\n description: AddMonitorComponentRequest is the request to add a monitor-based component to a status page.\n openstatus.status_page.v1.AddMonitorComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The created component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: AddMonitorComponentResponse\n additionalProperties: false\n description: AddMonitorComponentResponse is the response after adding a monitor component.\n openstatus.status_page.v1.AddStaticComponentRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to add the component to (required).\n name:\n type: string\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the component (required).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: Display order of the component (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: ID of the group to add this component to (optional).\n title: AddStaticComponentRequest\n additionalProperties: false\n description: AddStaticComponentRequest is the request to add a static component to a status page.\n openstatus.status_page.v1.AddStaticComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The created component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: AddStaticComponentResponse\n additionalProperties: false\n description: AddStaticComponentResponse is the response after adding a static component.\n openstatus.status_page.v1.ComponentDayBucket:\n type: object\n properties:\n day:\n type: string\n title: day\n description: Day in RFC 3339 format (UTC midnight).\n count:\n type:\n - integer\n - string\n title: count\n format: int64\n description: Total checks that day.\n ok:\n type:\n - integer\n - string\n title: ok\n format: int64\n description: Successful checks.\n degraded:\n type:\n - integer\n - string\n title: degraded\n format: int64\n description: Degraded checks.\n error:\n type:\n - integer\n - string\n title: error\n format: int64\n description: Failed checks.\n status:\n title: status\n description: Convenience resolved status for the day.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentDayStatus'\n impact:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n - type: \"null\"\n title: impact\n description: Worst status-report impact overlapping the day (absent when none).\n title: ComponentDayBucket\n additionalProperties: false\n description: ComponentDayBucket is one day of status data for a component.\n openstatus.status_page.v1.ComponentDayStatus:\n type: string\n title: ComponentDayStatus\n enum:\n - COMPONENT_DAY_STATUS_UNSPECIFIED\n - COMPONENT_DAY_STATUS_OPERATIONAL\n - COMPONENT_DAY_STATUS_DEGRADED\n - COMPONENT_DAY_STATUS_DOWN\n - COMPONENT_DAY_STATUS_MAINTENANCE\n - COMPONENT_DAY_STATUS_EMPTY\n description: ComponentDayStatus is the resolved status of a component on a given day.\n openstatus.status_page.v1.ComponentEvent:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Identifier of the underlying event.\n name:\n type: string\n title: name\n description: Human-readable name (incident \"Downtime\", maintenance / report title).\n type:\n title: type\n description: Kind of event.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEventType'\n status:\n title: status\n description: Projected status this event contributes.\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEventStatus'\n from:\n type: string\n title: from\n description: Start time (RFC 3339).\n to:\n type:\n - string\n - \"null\"\n title: to\n description: End time (RFC 3339); absent while the event is ongoing.\n impact:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n - type: \"null\"\n title: impact\n description: Worst impact over the event (reports only; absent otherwise).\n title: ComponentEvent\n additionalProperties: false\n description: ComponentEvent is a single incident / maintenance / report affecting a component.\n openstatus.status_page.v1.ComponentEventStatus:\n type: string\n title: ComponentEventStatus\n enum:\n - COMPONENT_EVENT_STATUS_UNSPECIFIED\n - COMPONENT_EVENT_STATUS_OPERATIONAL\n - COMPONENT_EVENT_STATUS_DEGRADED\n - COMPONENT_EVENT_STATUS_DOWN\n - COMPONENT_EVENT_STATUS_MAINTENANCE\n description: ComponentEventStatus is the projected status an event contributes.\n openstatus.status_page.v1.ComponentEventType:\n type: string\n title: ComponentEventType\n enum:\n - COMPONENT_EVENT_TYPE_UNSPECIFIED\n - COMPONENT_EVENT_TYPE_MAINTENANCE\n - COMPONENT_EVENT_TYPE_INCIDENT\n - COMPONENT_EVENT_TYPE_REPORT\n description: ComponentEventType is the kind of timeline event affecting a component.\n openstatus.status_page.v1.ComponentStatus:\n type: object\n properties:\n componentId:\n type: string\n title: component_id\n description: ID of the component.\n status:\n title: status\n description: Current status of the component.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n title: ComponentStatus\n additionalProperties: false\n description: ComponentStatus represents the status of a single component.\n openstatus.status_page.v1.CreateComponentGroupRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to create the group in (required).\n name:\n type: string\n title: name\n maxLength: 256\n minLength: 1\n description: Display name for the group (required).\n defaultOpen:\n type:\n - boolean\n - \"null\"\n title: default_open\n description: Whether the group should be expanded by default on the status page (optional, defaults to false).\n title: CreateComponentGroupRequest\n additionalProperties: false\n description: CreateComponentGroupRequest is the request to create a new component group.\n openstatus.status_page.v1.CreateComponentGroupResponse:\n type: object\n properties:\n group:\n title: group\n description: The created component group.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: CreateComponentGroupResponse\n additionalProperties: false\n description: CreateComponentGroupResponse is the response after creating a component group.\n openstatus.status_page.v1.CreatePageSubscriptionRequest:\n type: object\n allOf:\n - properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 255\n description: Optional human-readable label.\n componentIds:\n type: array\n items:\n type: string\n title: component_ids\n description: Component scope. Empty = entire page.\n - oneOf:\n - type: object\n properties:\n emailChannel:\n title: email_channel\n $ref: '#/components/schemas/openstatus.status_page.v1.EmailChannel'\n title: email_channel\n required:\n - emailChannel\n - type: object\n properties:\n webhookChannel:\n title: webhook_channel\n $ref: '#/components/schemas/openstatus.status_page.v1.WebhookChannel'\n title: webhook_channel\n required:\n - webhookChannel\n title: CreatePageSubscriptionRequest\n additionalProperties: false\n description: CreatePageSubscriptionRequest is the request to add a vendor-managed subscriber to a status page.\n openstatus.status_page.v1.CreatePageSubscriptionResponse:\n type: object\n properties:\n subscriber:\n title: subscriber\n description: The created subscriber.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: CreatePageSubscriptionResponse\n additionalProperties: false\n description: CreatePageSubscriptionResponse is the response after creating a vendor-managed subscription.\n openstatus.status_page.v1.CreateStatusPageRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - Acme Corp Status\n title: title\n maxLength: 256\n minLength: 1\n description: Title of the status page (required).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: Description of the status page (optional).\n slug:\n type: string\n examples:\n - my-status-page\n title: slug\n maxLength: 256\n minLength: 1\n pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$\n description: URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens.\n homepageUrl:\n type:\n - string\n - \"null\"\n examples:\n - https://www.example.com\n title: homepage_url\n description: URL to the homepage (optional).\n contactUrl:\n type:\n - string\n - \"null\"\n title: contact_url\n description: URL to the contact page (optional).\n defaultLocale:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n - type: \"null\"\n title: default_locale\n description: Default locale for the status page (optional, defaults to EN).\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: Enabled locales for the status page (optional).\n icon:\n type:\n - string\n - \"null\"\n title: icon\n maxLength: 1024\n description: Icon URL for the status page (optional).\n customDomain:\n type:\n - string\n - \"null\"\n title: custom_domain\n maxLength: 256\n description: Custom domain for the status page (optional).\n theme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n - type: \"null\"\n title: theme\n description: Visual theme for the status page (optional, defaults to SYSTEM).\n accessType:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n - type: \"null\"\n title: access_type\n description: Access type for the status page (optional, defaults to PUBLIC).\n password:\n type:\n - string\n - \"null\"\n title: password\n maxLength: 256\n minLength: 1\n description: Password for the status page (required when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: Email domains allowed to access the page (used when access_type is AUTHENTICATED).\n allowIndex:\n type:\n - boolean\n - \"null\"\n title: allow_index\n description: Whether search engines are allowed to index this status page (optional, defaults to true).\n allowedIpRanges:\n type:\n - string\n - \"null\"\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: |-\n Per-mode CSS variable overrides merged over the theme (optional).\n Only supported variable names are accepted. Requires the custom-theme plan feature.\n title: CreateStatusPageRequest\n additionalProperties: false\n description: CreateStatusPageRequest is the request to create a new status page.\n openstatus.status_page.v1.CreateStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The created status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: CreateStatusPageResponse\n additionalProperties: false\n description: CreateStatusPageResponse is the response after creating a status page.\n openstatus.status_page.v1.CustomTheme:\n type: object\n properties:\n light:\n type: object\n title: light\n additionalProperties:\n type: string\n title: value\n description: 'CSS variable overrides applied in light mode, keyed by variable name (e.g. \"--primary\": \"hsl(24 94% 50%)\").'\n dark:\n type: object\n title: dark\n additionalProperties:\n type: string\n title: value\n description: CSS variable overrides applied in dark mode, keyed by variable name.\n title: CustomTheme\n additionalProperties: false\n description: CustomTheme holds per-mode CSS variable overrides merged over the page theme.\n openstatus.status_page.v1.CustomTheme.DarkEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: DarkEntry\n additionalProperties: false\n openstatus.status_page.v1.CustomTheme.LightEntry:\n type: object\n properties:\n key:\n type: string\n title: key\n value:\n type: string\n title: value\n title: LightEntry\n additionalProperties: false\n openstatus.status_page.v1.DeleteComponentGroupRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component group to delete (required).\n title: DeleteComponentGroupRequest\n additionalProperties: false\n description: DeleteComponentGroupRequest is the request to delete a component group.\n openstatus.status_page.v1.DeleteComponentGroupResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteComponentGroupResponse\n additionalProperties: false\n description: DeleteComponentGroupResponse is the response after deleting a component group.\n openstatus.status_page.v1.DeleteStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to delete (required).\n title: DeleteStatusPageRequest\n additionalProperties: false\n description: DeleteStatusPageRequest is the request to delete a status page.\n openstatus.status_page.v1.DeleteStatusPageResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteStatusPageResponse\n additionalProperties: false\n description: DeleteStatusPageResponse is the response after deleting a status page.\n openstatus.status_page.v1.EmailChannel:\n type: object\n properties:\n email:\n type: string\n title: email\n format: email\n description: Email address of the subscriber (required).\n title: EmailChannel\n additionalProperties: false\n description: EmailChannel carries the email-channel fields for CreatePageSubscription.\n openstatus.status_page.v1.GetOverallStatusRequest:\n type: object\n oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetOverallStatusRequest\n additionalProperties: false\n description: GetOverallStatusRequest is the request to get the overall status of a status page.\n openstatus.status_page.v1.GetOverallStatusResponse:\n type: object\n properties:\n overallStatus:\n title: overall_status\n description: Aggregated status across all components.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n componentStatuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentStatus'\n title: component_statuses\n description: Status of individual components.\n title: GetOverallStatusResponse\n additionalProperties: false\n description: GetOverallStatusResponse is the response containing the overall status and individual component statuses.\n openstatus.status_page.v1.GetPageComponentDailySummaryRequest:\n type: object\n allOf:\n - properties:\n componentIds:\n type: array\n items:\n type: string\n minLength: 1\n title: component_ids\n description: Restrict the result to these component ids (optional, defaults to all components).\n days:\n type:\n - integer\n - \"null\"\n title: days\n maximum: 45\n minimum: 1\n format: int32\n description: Number of days to return (1-45, defaults to 45 if unspecified).\n - oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetPageComponentDailySummaryRequest\n additionalProperties: false\n description: GetPageComponentDailySummaryRequest is the request for per-component daily summaries.\n openstatus.status_page.v1.GetPageComponentDailySummaryResponse:\n type: object\n properties:\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentDailySummary'\n title: components\n description: Per-component daily summaries, in page order.\n title: GetPageComponentDailySummaryResponse\n additionalProperties: false\n description: GetPageComponentDailySummaryResponse is the response containing per-component summaries.\n openstatus.status_page.v1.GetPageComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to retrieve (required).\n title: GetPageComponentRequest\n additionalProperties: false\n description: GetPageComponentRequest is the request to fetch a single component by ID.\n openstatus.status_page.v1.GetPageComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The requested component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: GetPageComponentResponse\n additionalProperties: false\n description: GetPageComponentResponse is the response containing the component.\n openstatus.status_page.v1.GetStatusPageContentRequest:\n type: object\n oneOf:\n - type: object\n properties:\n id:\n type: string\n title: id\n description: ID of the status page.\n title: id\n required:\n - id\n - type: object\n properties:\n slug:\n type: string\n title: slug\n description: Slug of the status page.\n title: slug\n required:\n - slug\n title: GetStatusPageContentRequest\n additionalProperties: false\n description: GetStatusPageContentRequest is the request to get the full content of a status page.\n openstatus.status_page.v1.GetStatusPageContentResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The status page details.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: components\n description: Components on the status page.\n groups:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: groups\n description: Component groups on the status page.\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: status_reports\n description: Active and recent status reports.\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: Scheduled maintenances.\n title: GetStatusPageContentResponse\n additionalProperties: false\n description: GetStatusPageContentResponse is the response containing the full status page content.\n openstatus.status_page.v1.GetStatusPageOverviewRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page (required, workspace-scoped).\n title: GetStatusPageOverviewRequest\n additionalProperties: false\n description: GetStatusPageOverviewRequest requests the full overview of a status page by id.\n openstatus.status_page.v1.GetStatusPageOverviewResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The status page details.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n configuration:\n title: configuration\n description: Rich rendering configuration of the page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageConfiguration'\n components:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: components\n description: Components on the status page.\n groups:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: groups\n description: Component groups on the status page.\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: status_reports\n description: Active and recent status reports.\n maintenances:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary'\n title: maintenances\n description: Scheduled maintenances.\n overallStatus:\n title: overall_status\n description: Aggregated status across all components.\n $ref: '#/components/schemas/openstatus.status_page.v1.OverallStatus'\n componentStatuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentStatus'\n title: component_statuses\n description: Status of individual components.\n title: GetStatusPageOverviewResponse\n additionalProperties: false\n description: GetStatusPageOverviewResponse bundles all data for a single status page.\n openstatus.status_page.v1.GetStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to retrieve (required).\n title: GetStatusPageRequest\n additionalProperties: false\n description: GetStatusPageRequest is the request to get a status page by ID.\n openstatus.status_page.v1.GetStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The requested status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: GetStatusPageResponse\n additionalProperties: false\n description: GetStatusPageResponse is the response containing the status page.\n openstatus.status_page.v1.ListStatusPagesRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of pages to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of pages to skip for pagination (defaults to 0).\n title: ListStatusPagesRequest\n additionalProperties: false\n description: ListStatusPagesRequest is the request to list status pages.\n openstatus.status_page.v1.ListStatusPagesResponse:\n type: object\n properties:\n statusPages:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPageSummary'\n title: status_pages\n description: List of status pages (metadata only).\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of status pages.\n title: ListStatusPagesResponse\n additionalProperties: false\n description: ListStatusPagesResponse is the response containing status page summaries.\n openstatus.status_page.v1.ListSubscribersRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to list subscribers for (required).\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of subscribers to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of subscribers to skip for pagination (defaults to 0).\n includeUnsubscribed:\n type:\n - boolean\n - \"null\"\n title: include_unsubscribed\n description: Whether to include unsubscribed users (defaults to false).\n title: ListSubscribersRequest\n additionalProperties: false\n description: ListSubscribersRequest is the request to list subscribers of a status page.\n openstatus.status_page.v1.ListSubscribersResponse:\n type: object\n properties:\n subscribers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: subscribers\n description: List of subscribers.\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of subscribers matching the filter.\n title: ListSubscribersResponse\n additionalProperties: false\n description: ListSubscribersResponse is the response containing status page subscribers.\n openstatus.status_page.v1.Locale:\n type: string\n title: Locale\n enum:\n - LOCALE_UNSPECIFIED\n - LOCALE_EN\n - LOCALE_FR\n - LOCALE_DE\n - LOCALE_TR\n - LOCALE_HI\n - LOCALE_KO\n description: Locale defines the supported languages for a status page.\n openstatus.status_page.v1.OverallStatus:\n type: string\n title: OverallStatus\n enum:\n - OVERALL_STATUS_UNSPECIFIED\n - OVERALL_STATUS_OPERATIONAL\n - OVERALL_STATUS_DEGRADED\n - OVERALL_STATUS_PARTIAL_OUTAGE\n - OVERALL_STATUS_MAJOR_OUTAGE\n - OVERALL_STATUS_MAINTENANCE\n - OVERALL_STATUS_UNKNOWN\n description: OverallStatus represents the aggregated status of all components on a page.\n openstatus.status_page.v1.PageAccessType:\n type: string\n title: PageAccessType\n enum:\n - PAGE_ACCESS_TYPE_UNSPECIFIED\n - PAGE_ACCESS_TYPE_PUBLIC\n - PAGE_ACCESS_TYPE_PASSWORD_PROTECTED\n - PAGE_ACCESS_TYPE_AUTHENTICATED\n - PAGE_ACCESS_TYPE_IP_RESTRICTED\n description: PageAccessType defines who can access the status page.\n openstatus.status_page.v1.PageBarType:\n type: string\n title: PageBarType\n enum:\n - PAGE_BAR_TYPE_UNSPECIFIED\n - PAGE_BAR_TYPE_ABSOLUTE\n - PAGE_BAR_TYPE_MANUAL\n description: PageBarType mirrors page.configuration.type (how the status bar is computed).\n openstatus.status_page.v1.PageComponent:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the component.\n pageId:\n type: string\n title: page_id\n description: ID of the status page this component belongs to.\n name:\n type: string\n title: name\n description: Display name of the component.\n description:\n type: string\n title: description\n description: Description of the component (optional).\n type:\n title: type\n description: Type of the component (monitor or static).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentType'\n monitorId:\n type: string\n title: monitor_id\n description: ID of the monitor if type is MONITOR (optional).\n order:\n type: integer\n title: order\n format: int32\n description: Display order of the component.\n groupId:\n type: string\n title: group_id\n description: ID of the group this component belongs to (optional).\n groupOrder:\n type: integer\n title: group_order\n format: int32\n description: Order within the group if grouped.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the component was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the component was last updated (RFC 3339 format).\n title: PageComponent\n additionalProperties: false\n description: PageComponent represents a component displayed on a status page.\n openstatus.status_page.v1.PageComponentDailySummary:\n type: object\n properties:\n componentId:\n type: string\n title: component_id\n description: ID of the component.\n type:\n title: type\n description: Component type (monitor or static).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentType'\n monitorId:\n type:\n - string\n - \"null\"\n title: monitor_id\n description: Monitor id backing the component (absent for static components).\n name:\n type: string\n title: name\n description: Display name of the component.\n buckets:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentDayBucket'\n title: buckets\n description: Per-day buckets, oldest first.\n events:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.ComponentEvent'\n title: events\n description: Events affecting the component within the window.\n title: PageComponentDailySummary\n additionalProperties: false\n description: PageComponentDailySummary is the per-day buckets + event timeline for one component.\n openstatus.status_page.v1.PageComponentGroup:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the group.\n pageId:\n type: string\n title: page_id\n description: ID of the status page this group belongs to.\n name:\n type: string\n title: name\n description: Display name of the group.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the group was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the group was last updated (RFC 3339 format).\n defaultOpen:\n type: boolean\n title: default_open\n description: Whether the group should be expanded by default on the status page.\n title: PageComponentGroup\n additionalProperties: false\n description: PageComponentGroup represents a group of components on a status page.\n openstatus.status_page.v1.PageComponentType:\n type: string\n title: PageComponentType\n enum:\n - PAGE_COMPONENT_TYPE_UNSPECIFIED\n - PAGE_COMPONENT_TYPE_MONITOR\n - PAGE_COMPONENT_TYPE_STATIC\n description: PageComponentType defines the type of a component on a status page.\n openstatus.status_page.v1.PageConfiguration:\n type: object\n properties:\n metricType:\n title: metric_type\n description: Which metric the status bars represent (configuration.value).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageMetricType'\n barType:\n title: bar_type\n description: How the status bar is computed (configuration.type).\n $ref: '#/components/schemas/openstatus.status_page.v1.PageBarType'\n showUptime:\n type: boolean\n title: show_uptime\n description: Whether to show the uptime percentage (configuration.uptime).\n themeKey:\n type: string\n title: theme_key\n description: |-\n Theme key from the theme store (configuration.theme), e.g. \"default\".\n Free-form string rather than an enum because the theme catalog is dynamic.\n days:\n type: integer\n title: days\n format: int32\n description: 'Number of uptime-bar days rendered on the page (configuration.days): 30 or 45.'\n title: PageConfiguration\n additionalProperties: false\n description: PageConfiguration is the rich rendering config stored in page.configuration.\n openstatus.status_page.v1.PageMetricType:\n type: string\n title: PageMetricType\n enum:\n - PAGE_METRIC_TYPE_UNSPECIFIED\n - PAGE_METRIC_TYPE_DURATION\n - PAGE_METRIC_TYPE_REQUESTS\n - PAGE_METRIC_TYPE_MANUAL\n description: PageMetricType mirrors page.configuration.value (which metric the status bars represent).\n openstatus.status_page.v1.PageSubscriber:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the subscriber.\n pageId:\n type: string\n title: page_id\n description: ID of the status page the user is subscribed to.\n email:\n type: string\n title: email\n description: Email address of the subscriber (empty for webhook channels).\n acceptedAt:\n type: string\n title: accepted_at\n description: Timestamp when the subscription was accepted/confirmed (RFC 3339 format, optional).\n unsubscribedAt:\n type: string\n title: unsubscribed_at\n description: Timestamp when the user unsubscribed (RFC 3339 format, optional).\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the subscription was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the subscription was last updated (RFC 3339 format).\n source:\n title: source\n description: How the subscription was created. Vendor-added rows skip verification.\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscriberSource'\n name:\n type:\n - string\n - \"null\"\n title: name\n description: 'Optional human-readable label (e.g. \"Supabase #incidents\").'\n channelType:\n type: string\n title: channel_type\n description: 'Channel type: \"email\" or \"webhook\".'\n webhookUrl:\n type:\n - string\n - \"null\"\n title: webhook_url\n description: Webhook URL (populated only for channel_type = \"webhook\").\n channelConfig:\n type:\n - string\n - \"null\"\n title: channel_config\n description: JSON-encoded channel config (e.g. custom headers). Populated for webhook channels.\n componentIds:\n type: array\n items:\n type: string\n title: component_ids\n description: IDs of components this subscription is scoped to. Empty = entire page.\n title: PageSubscriber\n additionalProperties: false\n description: PageSubscriber represents a subscriber to a status page.\n openstatus.status_page.v1.PageTheme:\n type: string\n title: PageTheme\n enum:\n - PAGE_THEME_UNSPECIFIED\n - PAGE_THEME_SYSTEM\n - PAGE_THEME_LIGHT\n - PAGE_THEME_DARK\n description: PageTheme defines the visual theme of the status page.\n openstatus.status_page.v1.RemoveComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to remove (required).\n title: RemoveComponentRequest\n additionalProperties: false\n description: RemoveComponentRequest is the request to remove a component from a status page.\n openstatus.status_page.v1.RemoveComponentResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the removal was successful.\n title: RemoveComponentResponse\n additionalProperties: false\n description: RemoveComponentResponse is the response after removing a component.\n openstatus.status_page.v1.StatusPage:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status page.\n title:\n type: string\n title: title\n description: Title of the status page.\n description:\n type: string\n title: description\n description: Description of the status page.\n slug:\n type: string\n examples:\n - acme-corp\n title: slug\n description: URL-friendly slug for the status page.\n customDomain:\n type: string\n examples:\n - status.example.com\n title: custom_domain\n description: Custom domain for the status page (optional).\n published:\n type: boolean\n title: published\n description: Whether the status page is published and visible.\n accessType:\n title: access_type\n description: Access type for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n theme:\n title: theme\n description: Visual theme for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n homepageUrl:\n type: string\n title: homepage_url\n description: URL to the homepage (optional).\n contactUrl:\n type: string\n title: contact_url\n description: URL to the contact page (optional).\n icon:\n type: string\n title: icon\n description: Icon URL for the status page (optional).\n createdAt:\n type: string\n examples:\n - \"2024-01-15T09:00:00Z\"\n title: created_at\n description: Timestamp when the page was created (RFC 3339 format).\n updatedAt:\n type: string\n examples:\n - \"2024-06-20T14:30:00Z\"\n title: updated_at\n description: Timestamp when the page was last updated (RFC 3339 format).\n defaultLocale:\n title: default_locale\n description: Default locale for the status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: Enabled locales for the status page.\n password:\n type: string\n title: password\n description: Password for the status page (only set when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: Email domains allowed to access the page (only set when access_type is AUTHENTICATED).\n allowIndex:\n type: boolean\n title: allow_index\n description: Whether search engines are allowed to index this status page.\n allowedIpRanges:\n type: string\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (only set when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: Per-mode CSS variable overrides merged over the theme (only set when configured).\n title: StatusPage\n additionalProperties: false\n description: StatusPage represents a full status page with all details.\n openstatus.status_page.v1.StatusPageSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status page.\n title:\n type: string\n title: title\n description: Title of the status page.\n slug:\n type: string\n title: slug\n description: URL-friendly slug for the status page.\n published:\n type: boolean\n title: published\n description: Whether the status page is published and visible.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the page was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the page was last updated (RFC 3339 format).\n customDomain:\n type: string\n examples:\n - status.example.com\n title: custom_domain\n description: Custom domain for the status page (optional).\n title: StatusPageSummary\n additionalProperties: false\n description: StatusPageSummary represents metadata for a status page (used in list responses).\n openstatus.status_page.v1.SubscribeToPageRequest:\n type: object\n properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to subscribe to (required).\n email:\n type: string\n examples:\n - [email protected]\n title: email\n format: email\n description: Email address to subscribe (required).\n title: SubscribeToPageRequest\n additionalProperties: false\n description: SubscribeToPageRequest is the request to subscribe an email to a status page.\n openstatus.status_page.v1.SubscribeToPageResponse:\n type: object\n properties:\n subscriber:\n title: subscriber\n description: The created subscriber.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageSubscriber'\n title: SubscribeToPageResponse\n additionalProperties: false\n description: SubscribeToPageResponse is the response after subscribing to a status page.\n openstatus.status_page.v1.SubscriberSource:\n type: string\n title: SubscriberSource\n enum:\n - SUBSCRIBER_SOURCE_UNSPECIFIED\n - SUBSCRIBER_SOURCE_SELF_SIGNUP\n - SUBSCRIBER_SOURCE_VENDOR\n - SUBSCRIBER_SOURCE_IMPORT\n description: SubscriberSource indicates how the subscription was created.\n openstatus.status_page.v1.UnsubscribeFromPageRequest:\n type: object\n allOf:\n - properties:\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: ID of the status page to unsubscribe from (required).\n - oneOf:\n - type: object\n properties:\n email:\n type: string\n title: email\n description: Email address to unsubscribe.\n title: email\n required:\n - email\n - type: object\n properties:\n id:\n type: string\n title: id\n description: Subscriber ID.\n title: id\n required:\n - id\n title: UnsubscribeFromPageRequest\n additionalProperties: false\n description: UnsubscribeFromPageRequest is the request to unsubscribe from a status page.\n openstatus.status_page.v1.UnsubscribeFromPageResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the unsubscription was successful.\n title: UnsubscribeFromPageResponse\n additionalProperties: false\n description: UnsubscribeFromPageResponse is the response after unsubscribing from a status page.\n openstatus.status_page.v1.UpdateComponentGroupRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component group to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n minLength: 1\n description: New display name for the group (optional).\n defaultOpen:\n type:\n - boolean\n - \"null\"\n title: default_open\n description: Whether the group should be expanded by default on the status page (optional).\n title: UpdateComponentGroupRequest\n additionalProperties: false\n description: UpdateComponentGroupRequest is the request to update a component group.\n openstatus.status_page.v1.UpdateComponentGroupResponse:\n type: object\n properties:\n group:\n title: group\n description: The updated component group.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponentGroup'\n title: UpdateComponentGroupResponse\n additionalProperties: false\n description: UpdateComponentGroupResponse is the response after updating a component group.\n openstatus.status_page.v1.UpdateComponentRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the component to update (required).\n name:\n type:\n - string\n - \"null\"\n title: name\n maxLength: 256\n description: New display name for the component (optional).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: New description for the component (optional).\n order:\n type:\n - integer\n - \"null\"\n title: order\n format: int32\n description: New display order (optional).\n groupId:\n type:\n - string\n - \"null\"\n title: group_id\n description: New group ID (optional, set to empty string to remove from group).\n groupOrder:\n type:\n - integer\n - \"null\"\n title: group_order\n format: int32\n description: New order within the group (optional).\n title: UpdateComponentRequest\n additionalProperties: false\n description: UpdateComponentRequest is the request to update a component.\n openstatus.status_page.v1.UpdateComponentResponse:\n type: object\n properties:\n component:\n title: component\n description: The updated component.\n $ref: '#/components/schemas/openstatus.status_page.v1.PageComponent'\n title: UpdateComponentResponse\n additionalProperties: false\n description: UpdateComponentResponse is the response after updating a component.\n openstatus.status_page.v1.UpdateStatusPageRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status page to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n maxLength: 256\n minLength: 1\n description: New title for the status page (optional).\n description:\n type:\n - string\n - \"null\"\n title: description\n maxLength: 1024\n description: New description for the status page (optional).\n slug:\n type:\n - string\n - \"null\"\n title: slug\n maxLength: 256\n minLength: 1\n pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$\n description: New slug for the status page (optional).\n homepageUrl:\n type:\n - string\n - \"null\"\n title: homepage_url\n description: New homepage URL (optional).\n contactUrl:\n type:\n - string\n - \"null\"\n title: contact_url\n description: New contact URL (optional).\n defaultLocale:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n - type: \"null\"\n title: default_locale\n description: New default locale for the status page (optional).\n locales:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.Locale'\n title: locales\n description: New enabled locales for the status page (optional).\n icon:\n type:\n - string\n - \"null\"\n title: icon\n maxLength: 1024\n description: New icon URL for the status page (optional).\n customDomain:\n type:\n - string\n - \"null\"\n title: custom_domain\n maxLength: 256\n description: New custom domain (optional).\n theme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageTheme'\n - type: \"null\"\n title: theme\n description: New visual theme (optional).\n accessType:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.PageAccessType'\n - type: \"null\"\n title: access_type\n description: New access type (optional).\n password:\n type:\n - string\n - \"null\"\n title: password\n maxLength: 256\n minLength: 1\n description: New password (optional, required when access_type is PASSWORD_PROTECTED).\n authEmailDomains:\n type: array\n items:\n type: string\n title: auth_email_domains\n description: New email domains (optional, required when access_type is AUTHENTICATED).\n allowIndex:\n type:\n - boolean\n - \"null\"\n title: allow_index\n description: Whether search engines are allowed to index this status page (optional).\n allowedIpRanges:\n type:\n - string\n - \"null\"\n title: allowed_ip_ranges\n description: Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED).\n customTheme:\n oneOf:\n - $ref: '#/components/schemas/openstatus.status_page.v1.CustomTheme'\n - type: \"null\"\n title: custom_theme\n description: |-\n New per-mode CSS variable overrides (optional). Omit to keep the current\n value; send an empty message to clear. Requires the custom-theme plan feature.\n title: UpdateStatusPageRequest\n additionalProperties: false\n description: UpdateStatusPageRequest is the request to update a status page.\n openstatus.status_page.v1.UpdateStatusPageResponse:\n type: object\n properties:\n statusPage:\n title: status_page\n description: The updated status page.\n $ref: '#/components/schemas/openstatus.status_page.v1.StatusPage'\n title: UpdateStatusPageResponse\n additionalProperties: false\n description: UpdateStatusPageResponse is the response after updating a status page.\n openstatus.status_page.v1.WebhookChannel:\n type: object\n properties:\n webhookUrl:\n type: string\n title: webhook_url\n maxLength: 2048\n minLength: 1\n format: uri\n description: Webhook URL (required). Payload flavor (Slack / Discord / generic) is auto-detected from the URL prefix.\n headers:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_page.v1.WebhookChannelHeader'\n title: headers\n description: Optional custom HTTP headers attached to every dispatch.\n title: WebhookChannel\n additionalProperties: false\n description: WebhookChannel carries the webhook-channel fields for CreatePageSubscription.\n openstatus.status_page.v1.WebhookChannelHeader:\n type: object\n properties:\n key:\n type: string\n title: key\n minLength: 1\n value:\n type: string\n title: value\n title: WebhookChannelHeader\n additionalProperties: false\n description: WebhookChannelHeader is a single custom HTTP header.\n openstatus.status_report.v1.AddStatusReportUpdateRequest:\n type: object\n properties:\n statusReportId:\n type: string\n title: status_report_id\n minLength: 1\n description: ID of the status report to update (required).\n status:\n title: status\n description: New status for the report (required).\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n message:\n type: string\n title: message\n minLength: 1\n description: Message describing what changed (required).\n date:\n type:\n - string\n - \"null\"\n title: date\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Optional date for the update (RFC 3339 format). Defaults to current time if not provided.\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this update (optional, defaults to false).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: |-\n Per-component impacts this update sets (optional). Components named here\n are added to the report's affected set; omitted components keep their\n prior impact.\n title: AddStatusReportUpdateRequest\n additionalProperties: false\n description: AddStatusReportUpdateRequest is the request to add a new update to a status report.\n openstatus.status_report.v1.AddStatusReportUpdateResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The updated status report with the new update included.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: AddStatusReportUpdateResponse\n additionalProperties: false\n description: AddStatusReportUpdateResponse is the response after adding an update to a status report.\n openstatus.status_report.v1.ComponentImpact:\n type: object\n properties:\n pageComponentId:\n type: string\n title: page_component_id\n description: ID of the affected page component.\n impact:\n title: impact\n description: Impact set for the component.\n $ref: '#/components/schemas/openstatus.status_report.v1.PageComponentImpact'\n title: ComponentImpact\n additionalProperties: false\n description: ComponentImpact pairs a page component with the impact an update set for it.\n openstatus.status_report.v1.CreateStatusReportRequest:\n type: object\n properties:\n title:\n type: string\n examples:\n - API Degradation Investigation\n title: title\n minLength: 1\n description: Title of the status report (required).\n status:\n title: status\n description: Initial status (required).\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n message:\n type: string\n examples:\n - We are investigating reports of increased API latency.\n title: message\n minLength: 1\n description: Initial message describing the incident (required).\n date:\n type: string\n examples:\n - \"2024-03-15T10:30:00Z\"\n title: date\n pattern: ^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$\n description: Date when the event occurred (RFC 3339 format, required).\n pageId:\n type: string\n title: page_id\n minLength: 1\n description: Page ID to associate with this report (required).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: Page component IDs to associate with this report (optional).\n notify:\n type:\n - boolean\n - \"null\"\n title: notify\n description: Whether to notify subscribers about this status report (optional, defaults to false).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: |-\n Per-component impacts set by the initial update (optional). When provided,\n the named components are added to the report's affected set. Omitting this\n field creates a legacy report without impact tracking.\n title: CreateStatusReportRequest\n additionalProperties: false\n description: CreateStatusReportRequest is the request to create a new status report.\n openstatus.status_report.v1.CreateStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The created status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: CreateStatusReportResponse\n additionalProperties: false\n description: CreateStatusReportResponse is the response after creating a status report.\n openstatus.status_report.v1.DeleteStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to delete (required).\n title: DeleteStatusReportRequest\n additionalProperties: false\n description: DeleteStatusReportRequest is the request to delete a status report.\n openstatus.status_report.v1.DeleteStatusReportResponse:\n type: object\n properties:\n success:\n type: boolean\n title: success\n description: Whether the deletion was successful.\n title: DeleteStatusReportResponse\n additionalProperties: false\n description: DeleteStatusReportResponse is the response after deleting a status report.\n openstatus.status_report.v1.GetStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to retrieve (required).\n title: GetStatusReportRequest\n additionalProperties: false\n description: GetStatusReportRequest is the request to get a status report by ID.\n openstatus.status_report.v1.GetStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The requested status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: GetStatusReportResponse\n additionalProperties: false\n description: GetStatusReportResponse is the response containing the status report with its full update timeline.\n openstatus.status_report.v1.ListStatusReportsRequest:\n type: object\n properties:\n limit:\n type:\n - integer\n - \"null\"\n title: limit\n maximum: 100\n minimum: 1\n format: int32\n description: Maximum number of reports to return (1-100, defaults to 50).\n offset:\n type:\n - integer\n - \"null\"\n title: offset\n minimum: 0\n format: int32\n description: Number of reports to skip for pagination (defaults to 0).\n statuses:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title: statuses\n description: Filter by status (optional). If empty, returns all statuses.\n title: ListStatusReportsRequest\n additionalProperties: false\n description: ListStatusReportsRequest is the request to list status reports.\n openstatus.status_report.v1.ListStatusReportsResponse:\n type: object\n properties:\n statusReports:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportSummary'\n title: status_reports\n description: List of status reports (metadata only, use GetStatusReport for full details).\n totalSize:\n type: integer\n title: total_size\n format: int32\n description: Total number of reports matching the filter.\n title: ListStatusReportsResponse\n additionalProperties: false\n description: ListStatusReportsResponse is the response containing status report summaries.\n openstatus.status_report.v1.PageComponentImpact:\n type: string\n title: PageComponentImpact\n enum:\n - PAGE_COMPONENT_IMPACT_UNSPECIFIED\n - PAGE_COMPONENT_IMPACT_OPERATIONAL\n - PAGE_COMPONENT_IMPACT_DEGRADED_PERFORMANCE\n - PAGE_COMPONENT_IMPACT_PARTIAL_OUTAGE\n - PAGE_COMPONENT_IMPACT_MAJOR_OUTAGE\n description: |-\n PageComponentImpact is the per-component impact a status report update sets.\n UNSPECIFIED means the caller doesn't speak impact (legacy) — it is NOT operational.\n openstatus.status_report.v1.StatusReport:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status report.\n status:\n title: status\n description: Current status of the report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title:\n type: string\n title: title\n description: Title of the status report.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n updates:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportUpdate'\n title: updates\n description: Timeline of updates for this report (only included in GetStatusReport).\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the report was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the report was last updated (RFC 3339 format).\n title: StatusReport\n additionalProperties: false\n description: StatusReport represents an incident or maintenance report with full details.\n openstatus.status_report.v1.StatusReportStatus:\n type: string\n title: StatusReportStatus\n enum:\n - STATUS_REPORT_STATUS_UNSPECIFIED\n - STATUS_REPORT_STATUS_INVESTIGATING\n - STATUS_REPORT_STATUS_IDENTIFIED\n - STATUS_REPORT_STATUS_MONITORING\n - STATUS_REPORT_STATUS_RESOLVED\n description: StatusReportStatus represents the current state of a status report.\n openstatus.status_report.v1.StatusReportSummary:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the status report.\n status:\n title: status\n description: Current status of the report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n title:\n type: string\n title: title\n description: Title of the status report.\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: IDs of affected page components.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the report was created (RFC 3339 format).\n updatedAt:\n type: string\n title: updated_at\n description: Timestamp when the report was last updated (RFC 3339 format).\n title: StatusReportSummary\n additionalProperties: false\n description: StatusReportSummary represents metadata for a status report (used in list responses).\n openstatus.status_report.v1.StatusReportUpdate:\n type: object\n properties:\n id:\n type: string\n title: id\n description: Unique identifier for the update.\n status:\n title: status\n description: Status at the time of this update.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReportStatus'\n date:\n type: string\n title: date\n description: Timestamp when this update occurred (RFC 3339 format).\n message:\n type: string\n title: message\n description: Message describing the update.\n createdAt:\n type: string\n title: created_at\n description: Timestamp when the update was created (RFC 3339 format).\n componentImpacts:\n type: array\n items:\n $ref: '#/components/schemas/openstatus.status_report.v1.ComponentImpact'\n title: component_impacts\n description: Per-component impacts this update set (empty for legacy reports).\n title: StatusReportUpdate\n additionalProperties: false\n description: StatusReportUpdate represents a single update entry in a status report timeline.\n openstatus.status_report.v1.UpdateStatusReportRequest:\n type: object\n properties:\n id:\n type: string\n title: id\n minLength: 1\n description: ID of the status report to update (required).\n title:\n type:\n - string\n - \"null\"\n title: title\n description: New title for the report (optional).\n pageComponentIds:\n type: array\n items:\n type: string\n title: page_component_ids\n description: New list of page component IDs (optional, replaces existing list).\n updatePageComponentIds:\n type:\n - boolean\n - \"null\"\n title: update_page_component_ids\n description: |-\n Set to true to update page component associations.\n When true, page_component_ids replaces the existing list (empty clears all).\n When false or unset, page_component_ids is ignored and existing associations are preserved.\n title: UpdateStatusReportRequest\n additionalProperties: false\n description: UpdateStatusReportRequest is the request to update a status report's metadata.\n openstatus.status_report.v1.UpdateStatusReportResponse:\n type: object\n properties:\n statusReport:\n title: status_report\n description: The updated status report.\n $ref: '#/components/schemas/openstatus.status_report.v1.StatusReport'\n title: UpdateStatusReportResponse\n additionalProperties: false\n description: UpdateStatusReportResponse is the response after updating a status report.\nsecurity:\n - ApiKeyAuth: []\ntags:\n - name: MonitorService\n description: |\n Create, update, delete, and query monitors. Supports HTTP, TCP, and DNS monitor types\n with configurable check intervals, regions, assertions, and alerting thresholds.\n - name: StatusPageService\n description: |\n Manage public status pages with components, component groups, and email subscribers.\n Includes endpoints for retrieving full page content and aggregated status.\n - name: NotificationService\n description: |\n Configure notification channels (Slack, Discord, PagerDuty, email, webhooks, etc.)\n and associate them with monitors. Supports 12 notification providers.\n - name: StatusReportService\n description: |\n Create and manage incident reports with status updates. Reports follow a lifecycle:\n investigating -> identified -> monitoring -> resolved.\n - name: MaintenanceService\n description: |\n Schedule maintenance windows for status page components. Subscribers can be\n notified automatically when maintenance is created.\n - name: HealthService\n description: Health check endpoint for load balancer probes. No authentication required.\n - name: PrivateLocationService\n description: |-\n PrivateLocationService provides CRUD operations for private locations —\n self-hosted checker agents that run monitors from your own network.\npaths:\n /rpc/openstatus.health.v1.HealthService/Check:\n get:\n tags:\n - HealthService\n summary: Check\n description: Check returns the current serving status of the service.\n operationId: HealthService_Check.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse'\n post:\n tags:\n - HealthService\n summary: Check\n description: Check returns the current serving status of the service.\n operationId: HealthService_Check\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.health.v1.CheckResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/CreateMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: CreateMaintenance\n description: CreateMaintenance creates a new maintenance window.\n operationId: MaintenanceService_CreateMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: DeleteMaintenance\n description: DeleteMaintenance removes a maintenance window.\n operationId: MaintenanceService_DeleteMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/GetMaintenance:\n get:\n tags:\n - MaintenanceService\n summary: GetMaintenance\n description: GetMaintenance retrieves a specific maintenance window by ID.\n operationId: MaintenanceService_GetMaintenance.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse'\n post:\n tags:\n - MaintenanceService\n summary: GetMaintenance\n description: GetMaintenance retrieves a specific maintenance window by ID.\n operationId: MaintenanceService_GetMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/ListMaintenances:\n get:\n tags:\n - MaintenanceService\n summary: ListMaintenances\n description: ListMaintenances returns all maintenance windows for the workspace.\n operationId: MaintenanceService_ListMaintenances.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse'\n post:\n tags:\n - MaintenanceService\n summary: ListMaintenances\n description: ListMaintenances returns all maintenance windows for the workspace.\n operationId: MaintenanceService_ListMaintenances\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse'\n /rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenance:\n post:\n tags:\n - MaintenanceService\n summary: UpdateMaintenance\n description: UpdateMaintenance updates a maintenance window.\n operationId: MaintenanceService_UpdateMaintenance\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateDNSMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateDNSMonitor\n description: CreateDNSMonitor creates a new DNS monitor.\n operationId: MonitorService_CreateDNSMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateGRPCMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateGRPCMonitor\n description: CreateGRPCMonitor creates a new gRPC health check monitor.\n operationId: MonitorService_CreateGRPCMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateHTTPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateHTTPMonitor\n description: Creates a new HTTP monitor in the authenticated workspace. Configure the target URL, HTTP method, request headers and body, response assertions (status code, body content, headers), check periodicity, geographic regions, and optional OpenTelemetry export. The monitor starts checking immediately if set to active.\n operationId: MonitorService_CreateHTTPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateICMPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateICMPMonitor\n description: CreateICMPMonitor creates a new ICMP monitor.\n operationId: MonitorService_CreateICMPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/CreateTCPMonitor:\n post:\n tags:\n - MonitorService\n summary: CreateTCPMonitor\n description: CreateTCPMonitor creates a new TCP monitor.\n operationId: MonitorService_CreateTCPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/DeleteMonitor:\n post:\n tags:\n - MonitorService\n summary: DeleteMonitor\n description: DeleteMonitor removes a monitor.\n operationId: MonitorService_DeleteMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.DeleteMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.DeleteMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitor:\n get:\n tags:\n - MonitorService\n summary: GetMonitor\n description: |-\n GetMonitor returns a single monitor by ID within the authenticated workspace.\n Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.\n operationId: MonitorService_GetMonitor.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitor\n description: |-\n GetMonitor returns a single monitor by ID within the authenticated workspace.\n Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.\n operationId: MonitorService_GetMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorHTTPResponseLog:\n get:\n tags:\n - MonitorService\n summary: GetMonitorHTTPResponseLog\n description: GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.\n operationId: MonitorService_GetMonitorHTTPResponseLog.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorHTTPResponseLog\n description: GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.\n operationId: MonitorService_GetMonitorHTTPResponseLog\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorStatus:\n get:\n tags:\n - MonitorService\n summary: GetMonitorStatus\n description: GetMonitorStatus returns the current status of all regions for a monitor.\n operationId: MonitorService_GetMonitorStatus.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorStatus\n description: GetMonitorStatus returns the current status of all regions for a monitor.\n operationId: MonitorService_GetMonitorStatus\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse'\n /rpc/openstatus.monitor.v1.MonitorService/GetMonitorSummary:\n get:\n tags:\n - MonitorService\n summary: GetMonitorSummary\n description: Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.\n operationId: MonitorService_GetMonitorSummary.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse'\n post:\n tags:\n - MonitorService\n summary: GetMonitorSummary\n description: Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.\n operationId: MonitorService_GetMonitorSummary\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse'\n /rpc/openstatus.monitor.v1.MonitorService/ListMonitorHTTPResponseLogs:\n get:\n tags:\n - MonitorService\n summary: ListMonitorHTTPResponseLogs\n description: ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.\n operationId: MonitorService_ListMonitorHTTPResponseLogs.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse'\n post:\n tags:\n - MonitorService\n summary: ListMonitorHTTPResponseLogs\n description: ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.\n operationId: MonitorService_ListMonitorHTTPResponseLogs\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse'\n /rpc/openstatus.monitor.v1.MonitorService/ListMonitors:\n get:\n tags:\n - MonitorService\n summary: ListMonitors\n description: ListMonitors returns a paginated list of all monitors in the workspace.\n operationId: MonitorService_ListMonitors.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse'\n post:\n tags:\n - MonitorService\n summary: ListMonitors\n description: ListMonitors returns a paginated list of all monitors in the workspace.\n operationId: MonitorService_ListMonitors\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse'\n /rpc/openstatus.monitor.v1.MonitorService/TriggerMonitor:\n post:\n tags:\n - MonitorService\n summary: TriggerMonitor\n description: Manually triggers an immediate check for the specified monitor across all configured regions. This operation is rate-limited under the synthetic-checks quota. A monitor run record is created and the check is dispatched to the checker service.\n operationId: MonitorService_TriggerMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.TriggerMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.TriggerMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateDNSMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateDNSMonitor\n description: UpdateDNSMonitor updates an existing DNS monitor.\n operationId: MonitorService_UpdateDNSMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateGRPCMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateGRPCMonitor\n description: UpdateGRPCMonitor updates an existing gRPC monitor.\n operationId: MonitorService_UpdateGRPCMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateHTTPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateHTTPMonitor\n description: UpdateHTTPMonitor updates an existing HTTP monitor.\n operationId: MonitorService_UpdateHTTPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateICMPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateICMPMonitor\n description: UpdateICMPMonitor updates an existing ICMP monitor.\n operationId: MonitorService_UpdateICMPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorResponse'\n /rpc/openstatus.monitor.v1.MonitorService/UpdateTCPMonitor:\n post:\n tags:\n - MonitorService\n summary: UpdateTCPMonitor\n description: UpdateTCPMonitor updates an existing TCP monitor.\n operationId: MonitorService_UpdateTCPMonitor\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorResponse'\n /rpc/openstatus.notification.v1.NotificationService/CheckNotificationLimit:\n get:\n tags:\n - NotificationService\n summary: CheckNotificationLimit\n description: CheckNotificationLimit checks if the workspace has reached its notification limit.\n operationId: NotificationService_CheckNotificationLimit.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse'\n post:\n tags:\n - NotificationService\n summary: CheckNotificationLimit\n description: CheckNotificationLimit checks if the workspace has reached its notification limit.\n operationId: NotificationService_CheckNotificationLimit\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse'\n /rpc/openstatus.notification.v1.NotificationService/CreateNotification:\n post:\n tags:\n - NotificationService\n summary: CreateNotification\n description: CreateNotification creates a new notification channel.\n operationId: NotificationService_CreateNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CreateNotificationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.CreateNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/DeleteNotification:\n post:\n tags:\n - NotificationService\n summary: DeleteNotification\n description: DeleteNotification removes a notification channel.\n operationId: NotificationService_DeleteNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.DeleteNotificationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.DeleteNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/GetNotification:\n get:\n tags:\n - NotificationService\n summary: GetNotification\n description: GetNotification retrieves a notification channel by ID.\n operationId: NotificationService_GetNotification.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationResponse'\n post:\n tags:\n - NotificationService\n summary: GetNotification\n description: GetNotification retrieves a notification channel by ID.\n operationId: NotificationService_GetNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.GetNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/ListNotifications:\n get:\n tags:\n - NotificationService\n summary: ListNotifications\n description: ListNotifications returns a list of notification channels.\n operationId: NotificationService_ListNotifications.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsResponse'\n post:\n tags:\n - NotificationService\n summary: ListNotifications\n description: ListNotifications returns a list of notification channels.\n operationId: NotificationService_ListNotifications\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.ListNotificationsResponse'\n /rpc/openstatus.notification.v1.NotificationService/SendTestNotification:\n post:\n tags:\n - NotificationService\n summary: SendTestNotification\n description: Sends a test notification to the specified provider to verify that the configuration is correct. This does not require an existing notification channel - just provide the provider type and its configuration data. Returns success status and an error message if the test failed.\n operationId: NotificationService_SendTestNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.SendTestNotificationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.SendTestNotificationResponse'\n /rpc/openstatus.notification.v1.NotificationService/UpdateNotification:\n post:\n tags:\n - NotificationService\n summary: UpdateNotification\n description: UpdateNotification updates an existing notification channel.\n operationId: NotificationService_UpdateNotification\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.UpdateNotificationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.notification.v1.UpdateNotificationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/CreatePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: CreatePrivateLocation\n description: Creates a private location. The agent token is generated by the server and returned in the response - it cannot be supplied by the caller. Use the token to configure the agent so it can pull its monitors and report results.\n operationId: PrivateLocationService_CreatePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/DeletePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: DeletePrivateLocation\n description: DeletePrivateLocation removes a private location.\n operationId: PrivateLocationService_DeletePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/GetPrivateLocation:\n get:\n tags:\n - PrivateLocationService\n summary: GetPrivateLocation\n description: |-\n GetPrivateLocation retrieves a single private location by ID, including\n its agent token.\n operationId: PrivateLocationService_GetPrivateLocation.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse'\n post:\n tags:\n - PrivateLocationService\n summary: GetPrivateLocation\n description: |-\n GetPrivateLocation retrieves a single private location by ID, including\n its agent token.\n operationId: PrivateLocationService_GetPrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/ListPrivateLocations:\n get:\n tags:\n - PrivateLocationService\n summary: ListPrivateLocations\n description: |-\n ListPrivateLocations returns a paginated list of private location\n summaries. Agent tokens are not included - use GetPrivateLocation.\n operationId: PrivateLocationService_ListPrivateLocations.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse'\n post:\n tags:\n - PrivateLocationService\n summary: ListPrivateLocations\n description: |-\n ListPrivateLocations returns a paginated list of private location\n summaries. Agent tokens are not included - use GetPrivateLocation.\n operationId: PrivateLocationService_ListPrivateLocations\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse'\n /rpc/openstatus.private_location.v1.PrivateLocationService/UpdatePrivateLocation:\n post:\n tags:\n - PrivateLocationService\n summary: UpdatePrivateLocation\n description: UpdatePrivateLocation updates a private location.\n operationId: PrivateLocationService_UpdatePrivateLocation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/AddMonitorComponent:\n post:\n tags:\n - StatusPageService\n summary: AddMonitorComponent\n description: AddMonitorComponent adds a monitor-based component to a status page.\n operationId: StatusPageService_AddMonitorComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddMonitorComponentRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddMonitorComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/AddStaticComponent:\n post:\n tags:\n - StatusPageService\n summary: AddStaticComponent\n description: AddStaticComponent adds a static component to a status page.\n operationId: StatusPageService_AddStaticComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddStaticComponentRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.AddStaticComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreateComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: CreateComponentGroup\n description: CreateComponentGroup creates a new component group.\n operationId: StatusPageService_CreateComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateComponentGroupRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreatePageSubscription:\n post:\n tags:\n - StatusPageService\n summary: 'CreatePageSubscription: operator-added subscriber (email or webhook), no verification.'\n description: Operator-added subscriber (email or webhook) with no verification flow — the partner starts receiving notifications immediately. Supports Slack and Discord webhook URLs in addition to email. A management token is still generated so the subscriber can self-manage (update scope, unsubscribe) without operator involvement. Use this for vendor/partner integrations where consent is established out-of-band; use SubscribeToPage for subscriber-initiated signups that require double opt-in.\n operationId: StatusPageService_CreatePageSubscription\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/CreateStatusPage:\n post:\n tags:\n - StatusPageService\n summary: CreateStatusPage\n description: CreateStatusPage creates a new status page.\n operationId: StatusPageService_CreateStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateStatusPageRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.CreateStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/DeleteComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: DeleteComponentGroup\n description: DeleteComponentGroup removes a component group.\n operationId: StatusPageService_DeleteComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/DeleteStatusPage:\n post:\n tags:\n - StatusPageService\n summary: DeleteStatusPage\n description: DeleteStatusPage removes a status page.\n operationId: StatusPageService_DeleteStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteStatusPageRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.DeleteStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetOverallStatus:\n get:\n tags:\n - StatusPageService\n summary: GetOverallStatus\n description: 'Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.'\n operationId: StatusPageService_GetOverallStatus.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse'\n post:\n tags:\n - StatusPageService\n summary: GetOverallStatus\n description: 'Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.'\n operationId: StatusPageService_GetOverallStatus\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetPageComponent:\n get:\n tags:\n - StatusPageService\n summary: GetPageComponent\n description: Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.\n operationId: StatusPageService_GetPageComponent.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse'\n post:\n tags:\n - StatusPageService\n summary: GetPageComponent\n description: Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.\n operationId: StatusPageService_GetPageComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetPageComponentDailySummary:\n get:\n tags:\n - StatusPageService\n summary: GetPageComponentDailySummary\n description: 'Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetPageComponentDailySummary.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse'\n post:\n tags:\n - StatusPageService\n summary: GetPageComponentDailySummary\n description: 'Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetPageComponentDailySummary\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPage:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPage\n description: GetStatusPage retrieves a specific status page by ID.\n operationId: StatusPageService_GetStatusPage.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPage\n description: GetStatusPage retrieves a specific status page by ID.\n operationId: StatusPageService_GetStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageContent:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPageContent\n description: 'Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetStatusPageContent.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPageContent\n description: 'Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).'\n operationId: StatusPageService_GetStatusPageContent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageOverview:\n get:\n tags:\n - StatusPageService\n summary: GetStatusPageOverview\n description: 'Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.'\n operationId: StatusPageService_GetStatusPageOverview.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse'\n post:\n tags:\n - StatusPageService\n summary: GetStatusPageOverview\n description: 'Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.'\n operationId: StatusPageService_GetStatusPageOverview\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/ListStatusPages:\n get:\n tags:\n - StatusPageService\n summary: ListStatusPages\n description: ListStatusPages returns all status pages for the workspace.\n operationId: StatusPageService_ListStatusPages.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse'\n post:\n tags:\n - StatusPageService\n summary: ListStatusPages\n description: ListStatusPages returns all status pages for the workspace.\n operationId: StatusPageService_ListStatusPages\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/ListSubscribers:\n get:\n tags:\n - StatusPageService\n summary: ListSubscribers\n description: ListSubscribers returns all subscribers for a status page.\n operationId: StatusPageService_ListSubscribers.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse'\n post:\n tags:\n - StatusPageService\n summary: ListSubscribers\n description: ListSubscribers returns all subscribers for a status page.\n operationId: StatusPageService_ListSubscribers\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/RemoveComponent:\n post:\n tags:\n - StatusPageService\n summary: RemoveComponent\n description: RemoveComponent removes a component from a status page.\n operationId: StatusPageService_RemoveComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.RemoveComponentRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.RemoveComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/SubscribeToPage:\n post:\n tags:\n - StatusPageService\n summary: 'SubscribeToPage: end-user email self-signup with double opt-in verification.'\n description: End-user email self-signup with double opt-in verification. A verification email is sent and the subscription activates only after the recipient confirms. If the email was previously unsubscribed, the existing row is reactivated instead of a duplicate being created. Use this for subscriber-initiated signups on the public status page; use CreatePageSubscription for operator-initiated (vendor) subscriptions that should skip verification.\n operationId: StatusPageService_SubscribeToPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscribeToPageRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.SubscribeToPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UnsubscribeFromPage:\n post:\n tags:\n - StatusPageService\n summary: UnsubscribeFromPage\n description: UnsubscribeFromPage removes a subscription from a status page.\n operationId: StatusPageService_UnsubscribeFromPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateComponent:\n post:\n tags:\n - StatusPageService\n summary: UpdateComponent\n description: UpdateComponent updates an existing component.\n operationId: StatusPageService_UpdateComponent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateComponentGroup:\n post:\n tags:\n - StatusPageService\n summary: UpdateComponentGroup\n description: UpdateComponentGroup updates an existing component group.\n operationId: StatusPageService_UpdateComponentGroup\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupResponse'\n /rpc/openstatus.status_page.v1.StatusPageService/UpdateStatusPage:\n post:\n tags:\n - StatusPageService\n summary: UpdateStatusPage\n description: UpdateStatusPage updates an existing status page.\n operationId: StatusPageService_UpdateStatusPage\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateStatusPageRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_page.v1.UpdateStatusPageResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/AddStatusReportUpdate:\n post:\n tags:\n - StatusReportService\n summary: AddStatusReportUpdate\n description: 'Adds a new update entry to an existing status report and transitions the report to the specified status. Status reports follow a lifecycle: investigating -> identified -> monitoring -> resolved. If notify is true, subscribers of the associated page are notified by email about the update.'\n operationId: StatusReportService_AddStatusReportUpdate\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/CreateStatusReport:\n post:\n tags:\n - StatusReportService\n summary: CreateStatusReport\n description: Creates a new status report with an initial update entry. The report is associated with a status page and optionally specific page components. An initial StatusReportUpdate is created automatically with the provided status, message, and date. If notify is true, subscribers of the associated page are notified by email.\n operationId: StatusReportService_CreateStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.CreateStatusReportRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.CreateStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/DeleteStatusReport:\n post:\n tags:\n - StatusReportService\n summary: DeleteStatusReport\n description: DeleteStatusReport removes a status report and all its updates.\n operationId: StatusReportService_DeleteStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.DeleteStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/GetStatusReport:\n get:\n tags:\n - StatusReportService\n summary: GetStatusReport\n description: GetStatusReport retrieves a specific status report by ID (includes full update timeline).\n operationId: StatusReportService_GetStatusReport.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse'\n post:\n tags:\n - StatusReportService\n summary: GetStatusReport\n description: GetStatusReport retrieves a specific status report by ID (includes full update timeline).\n operationId: StatusReportService_GetStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/ListStatusReports:\n get:\n tags:\n - StatusReportService\n summary: ListStatusReports\n description: ListStatusReports returns all status reports for the workspace (metadata only).\n operationId: StatusReportService_ListStatusReports.get\n parameters:\n - name: message\n in: query\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest'\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse'\n post:\n tags:\n - StatusReportService\n summary: ListStatusReports\n description: ListStatusReports returns all status reports for the workspace (metadata only).\n operationId: StatusReportService_ListStatusReports\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse'\n /rpc/openstatus.status_report.v1.StatusReportService/UpdateStatusReport:\n post:\n tags:\n - StatusReportService\n summary: UpdateStatusReport\n description: UpdateStatusReport updates the metadata of a status report (title, page components).\n operationId: StatusReportService_UpdateStatusReport\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportRequest'\n required: true\n responses:\n default:\n description: Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/connect.error'\n \"200\":\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/openstatus.status_report.v1.UpdateStatusReportResponse'\n";
diff --git a/apps/server/static/openapi.json b/apps/server/static/openapi.json
new file mode 100644
index 000000000..6c86c7640
--- /dev/null
+++ b/apps/server/static/openapi.json
@@ -0,0 +1,9626 @@
+{
+ "openapi": "3.1.0",
+ "info": {
+ "description": "OpenStatus is a open-source status page platform with global uptime monitoring. The OpenStatus API allows you to interact with the OpenStatus platform programmatically. To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings.",
+ "title": "OpenStatus API",
+ "version": "v2.0.0",
+ "contact": {
+ "email": "[email protected]",
+ "url": "https://www.openstatus.dev"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://api.openstatus.dev",
+ "description": "Production"
+ }
+ ],
+ "externalDocs": {
+ "description": "OpenStatus Documentation",
+ "url": "https://www.openstatus.dev/docs"
+ },
+ "components": {
+ "securitySchemes": {
+ "ApiKeyAuth": {
+ "type": "apiKey",
+ "in": "header",
+ "name": "x-openstatus-key"
+ }
+ },
+ "schemas": {
+ "connect.error": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "examples": ["not_found"],
+ "enum": [
+ "canceled",
+ "unknown",
+ "invalid_argument",
+ "deadline_exceeded",
+ "not_found",
+ "already_exists",
+ "permission_denied",
+ "resource_exhausted",
+ "failed_precondition",
+ "aborted",
+ "out_of_range",
+ "unimplemented",
+ "internal",
+ "unavailable",
+ "data_loss",
+ "unauthenticated"
+ ],
+ "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]."
+ },
+ "message": {
+ "type": "string",
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connect.error_details.Any"
+ },
+ "description": "A list of messages that carry the error details. There is no limit on the number of messages."
+ }
+ },
+ "title": "Connect Error",
+ "additionalProperties": true,
+ "description": "Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation"
+ },
+ "connect.error_details.Any": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field."
+ },
+ "value": {
+ "type": "string",
+ "format": "binary",
+ "description": "The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field."
+ },
+ "debug": {
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "Any",
+ "additionalProperties": true,
+ "description": "Detailed error information."
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type"
+ },
+ "title": "Debug",
+ "description": "Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic."
+ }
+ },
+ "additionalProperties": true,
+ "description": "Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details."
+ },
+ "openstatus.health.v1.CheckRequest": {
+ "type": "object",
+ "properties": {
+ "service": {
+ "type": "string",
+ "title": "service",
+ "description": "Optional service name to check. If empty, checks overall service health."
+ }
+ },
+ "title": "CheckRequest",
+ "additionalProperties": false,
+ "description": "CheckRequest is the request message for health checks."
+ },
+ "openstatus.health.v1.CheckResponse": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "title": "status",
+ "description": "The serving status of the service.",
+ "$ref": "#/components/schemas/openstatus.health.v1.CheckResponse.ServingStatus"
+ }
+ },
+ "title": "CheckResponse",
+ "additionalProperties": false,
+ "description": "CheckResponse is the response message for health checks."
+ },
+ "openstatus.health.v1.CheckResponse.ServingStatus": {
+ "type": "string",
+ "title": "ServingStatus",
+ "enum": [
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING_STATUS_SERVING",
+ "SERVING_STATUS_NOT_SERVING"
+ ],
+ "description": "ServingStatus represents the health status of the service."
+ },
+ "openstatus.maintenance.v1.CreateMaintenanceRequest": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "examples": ["Database Migration"],
+ "title": "title",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Title of the maintenance (required, 1-256 characters)."
+ },
+ "message": {
+ "type": "string",
+ "title": "message",
+ "minLength": 1,
+ "description": "Message describing the maintenance (required)."
+ },
+ "from": {
+ "type": "string",
+ "examples": ["2024-03-01T02:00:00Z"],
+ "title": "from",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
+ "description": "Start time of the maintenance window (RFC 3339 format, required)."
+ },
+ "to": {
+ "type": "string",
+ "examples": ["2024-03-01T06:00:00Z"],
+ "title": "to",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
+ "description": "End time of the maintenance window (RFC 3339 format, required)."
+ },
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "Page ID to associate with this maintenance (required)."
+ },
+ "pageComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "page_component_ids",
+ "description": "Page component IDs to associate with this maintenance (optional)."
+ },
+ "notify": {
+ "type": ["boolean", "null"],
+ "title": "notify",
+ "description": "Whether to notify subscribers about this maintenance (optional, defaults to false)."
+ }
+ },
+ "title": "CreateMaintenanceRequest",
+ "additionalProperties": false,
+ "description": "CreateMaintenanceRequest is the request to create a new maintenance window."
+ },
+ "openstatus.maintenance.v1.CreateMaintenanceResponse": {
+ "type": "object",
+ "properties": {
+ "maintenance": {
+ "title": "maintenance",
+ "description": "The created maintenance.",
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.Maintenance"
+ }
+ },
+ "title": "CreateMaintenanceResponse",
+ "additionalProperties": false,
+ "description": "CreateMaintenanceResponse is the response after creating a maintenance window."
+ },
+ "openstatus.maintenance.v1.DeleteMaintenanceRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the maintenance to delete (required)."
+ }
+ },
+ "title": "DeleteMaintenanceRequest",
+ "additionalProperties": false,
+ "description": "DeleteMaintenanceRequest is the request to delete a maintenance window."
+ },
+ "openstatus.maintenance.v1.DeleteMaintenanceResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the deletion was successful."
+ }
+ },
+ "title": "DeleteMaintenanceResponse",
+ "additionalProperties": false,
+ "description": "DeleteMaintenanceResponse is the response after deleting a maintenance window."
+ },
+ "openstatus.maintenance.v1.GetMaintenanceRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the maintenance to retrieve (required)."
+ }
+ },
+ "title": "GetMaintenanceRequest",
+ "additionalProperties": false,
+ "description": "GetMaintenanceRequest is the request to get a maintenance window by ID."
+ },
+ "openstatus.maintenance.v1.GetMaintenanceResponse": {
+ "type": "object",
+ "properties": {
+ "maintenance": {
+ "title": "maintenance",
+ "description": "The requested maintenance.",
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.Maintenance"
+ }
+ },
+ "title": "GetMaintenanceResponse",
+ "additionalProperties": false,
+ "description": "GetMaintenanceResponse is the response containing the maintenance window."
+ },
+ "openstatus.maintenance.v1.ListMaintenancesRequest": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": ["integer", "null"],
+ "title": "limit",
+ "maximum": 100,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Maximum number of maintenances to return (1-100, defaults to 50)."
+ },
+ "offset": {
+ "type": ["integer", "null"],
+ "title": "offset",
+ "minimum": 0,
+ "format": "int32",
+ "description": "Number of maintenances to skip for pagination (defaults to 0)."
+ },
+ "pageId": {
+ "type": ["string", "null"],
+ "title": "page_id",
+ "description": "Filter by page ID (optional)."
+ }
+ },
+ "title": "ListMaintenancesRequest",
+ "additionalProperties": false,
+ "description": "ListMaintenancesRequest is the request to list maintenance windows."
+ },
+ "openstatus.maintenance.v1.ListMaintenancesResponse": {
+ "type": "object",
+ "properties": {
+ "maintenances": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary"
+ },
+ "title": "maintenances",
+ "description": "List of maintenances."
+ },
+ "totalSize": {
+ "type": "integer",
+ "title": "total_size",
+ "format": "int32",
+ "description": "Total number of maintenances matching the filter."
+ }
+ },
+ "title": "ListMaintenancesResponse",
+ "additionalProperties": false,
+ "description": "ListMaintenancesResponse is the response containing maintenance window summaries."
+ },
+ "openstatus.maintenance.v1.Maintenance": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the maintenance."
+ },
+ "title": {
+ "type": "string",
+ "title": "title",
+ "description": "Title of the maintenance."
+ },
+ "message": {
+ "type": "string",
+ "title": "message",
+ "description": "Message describing the maintenance."
+ },
+ "from": {
+ "type": "string",
+ "title": "from",
+ "description": "Start time of the maintenance window (RFC 3339 format)."
+ },
+ "to": {
+ "type": "string",
+ "title": "to",
+ "description": "End time of the maintenance window (RFC 3339 format)."
+ },
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "description": "ID of the page this maintenance is associated with."
+ },
+ "pageComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "page_component_ids",
+ "description": "IDs of affected page components."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the maintenance was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the maintenance was last updated (RFC 3339 format)."
+ }
+ },
+ "title": "Maintenance",
+ "additionalProperties": false,
+ "description": "Maintenance represents a maintenance window with full details."
+ },
+ "openstatus.maintenance.v1.MaintenanceSummary": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the maintenance."
+ },
+ "title": {
+ "type": "string",
+ "title": "title",
+ "description": "Title of the maintenance."
+ },
+ "message": {
+ "type": "string",
+ "title": "message",
+ "description": "Message describing the maintenance."
+ },
+ "from": {
+ "type": "string",
+ "title": "from",
+ "description": "Start time of the maintenance window (RFC 3339 format)."
+ },
+ "to": {
+ "type": "string",
+ "title": "to",
+ "description": "End time of the maintenance window (RFC 3339 format)."
+ },
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "description": "ID of the page this maintenance is associated with."
+ },
+ "pageComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "page_component_ids",
+ "description": "IDs of affected page components."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the maintenance was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the maintenance was last updated (RFC 3339 format)."
+ }
+ },
+ "title": "MaintenanceSummary",
+ "additionalProperties": false,
+ "description": "MaintenanceSummary represents metadata for a maintenance window (used in list responses)."
+ },
+ "openstatus.maintenance.v1.UpdateMaintenanceRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the maintenance to update (required)."
+ },
+ "title": {
+ "type": ["string", "null"],
+ "title": "title",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "New title for the maintenance (optional)."
+ },
+ "message": {
+ "type": ["string", "null"],
+ "title": "message",
+ "description": "New message for the maintenance (optional)."
+ },
+ "from": {
+ "type": ["string", "null"],
+ "title": "from",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
+ "description": "New start time (RFC 3339 format, optional)."
+ },
+ "to": {
+ "type": ["string", "null"],
+ "title": "to",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
+ "description": "New end time (RFC 3339 format, optional)."
+ },
+ "pageId": {
+ "type": ["string", "null"],
+ "title": "page_id",
+ "description": "Deprecated: page_id is now derived from page_component_ids.",
+ "deprecated": true
+ },
+ "pageComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "page_component_ids",
+ "description": "New list of page component IDs (optional, replaces existing list)."
+ },
+ "updatePageComponentIds": {
+ "type": ["boolean", "null"],
+ "title": "update_page_component_ids",
+ "description": "Set to true to update page component associations.\n When true, page_component_ids replaces the existing list (empty clears all).\n When false or unset, page_component_ids is ignored and existing associations are preserved."
+ }
+ },
+ "title": "UpdateMaintenanceRequest",
+ "additionalProperties": false,
+ "description": "UpdateMaintenanceRequest is the request to update a maintenance window."
+ },
+ "openstatus.maintenance.v1.UpdateMaintenanceResponse": {
+ "type": "object",
+ "properties": {
+ "maintenance": {
+ "title": "maintenance",
+ "description": "The updated maintenance.",
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.Maintenance"
+ }
+ },
+ "title": "UpdateMaintenanceResponse",
+ "additionalProperties": false,
+ "description": "UpdateMaintenanceResponse is the response after updating a maintenance window."
+ },
+ "openstatus.monitor.v1.BodyAssertion": {
+ "type": "object",
+ "properties": {
+ "target": {
+ "type": "string",
+ "title": "target",
+ "description": "Target value to compare against."
+ },
+ "comparator": {
+ "not": {
+ "enum": ["STRING_COMPARATOR_UNSPECIFIED"]
+ },
+ "title": "comparator",
+ "description": "Comparison operation (required, must not be UNSPECIFIED).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.StringComparator"
+ }
+ },
+ "title": "BodyAssertion",
+ "additionalProperties": false,
+ "description": "BodyAssertion defines an assertion for response body content."
+ },
+ "openstatus.monitor.v1.CreateDNSMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "Monitor configuration (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.DNSMonitor"
+ }
+ },
+ "title": "CreateDNSMonitorRequest",
+ "required": ["monitor"],
+ "additionalProperties": false,
+ "description": "CreateDNSMonitorRequest is the request to create a new DNS monitor."
+ },
+ "openstatus.monitor.v1.CreateDNSMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The created monitor with assigned ID.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.DNSMonitor"
+ }
+ },
+ "title": "CreateDNSMonitorResponse",
+ "additionalProperties": false,
+ "description": "CreateDNSMonitorResponse is the response after creating a DNS monitor."
+ },
+ "openstatus.monitor.v1.CreateGRPCMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "Monitor configuration (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GRPCMonitor"
+ }
+ },
+ "title": "CreateGRPCMonitorRequest",
+ "required": ["monitor"],
+ "additionalProperties": false,
+ "description": "CreateGRPCMonitorRequest is the request to create a new gRPC monitor."
+ },
+ "openstatus.monitor.v1.CreateGRPCMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The created monitor with assigned ID.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GRPCMonitor"
+ }
+ },
+ "title": "CreateGRPCMonitorResponse",
+ "additionalProperties": false,
+ "description": "CreateGRPCMonitorResponse is the response after creating a gRPC monitor."
+ },
+ "openstatus.monitor.v1.CreateHTTPMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "Monitor configuration (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPMonitor"
+ }
+ },
+ "title": "CreateHTTPMonitorRequest",
+ "required": ["monitor"],
+ "additionalProperties": false,
+ "description": "CreateHTTPMonitorRequest is the request to create a new HTTP monitor."
+ },
+ "openstatus.monitor.v1.CreateHTTPMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The created monitor with assigned ID.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPMonitor"
+ }
+ },
+ "title": "CreateHTTPMonitorResponse",
+ "additionalProperties": false,
+ "description": "CreateHTTPMonitorResponse is the response after creating an HTTP monitor."
+ },
+ "openstatus.monitor.v1.CreateICMPMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "Monitor configuration (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ICMPMonitor"
+ }
+ },
+ "title": "CreateICMPMonitorRequest",
+ "required": ["monitor"],
+ "additionalProperties": false,
+ "description": "CreateICMPMonitorRequest is the request to create a new ICMP monitor."
+ },
+ "openstatus.monitor.v1.CreateICMPMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The created monitor with assigned ID.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ICMPMonitor"
+ }
+ },
+ "title": "CreateICMPMonitorResponse",
+ "additionalProperties": false,
+ "description": "CreateICMPMonitorResponse is the response after creating an ICMP monitor."
+ },
+ "openstatus.monitor.v1.CreateTCPMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "Monitor configuration (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TCPMonitor"
+ }
+ },
+ "title": "CreateTCPMonitorRequest",
+ "required": ["monitor"],
+ "additionalProperties": false,
+ "description": "CreateTCPMonitorRequest is the request to create a new TCP monitor."
+ },
+ "openstatus.monitor.v1.CreateTCPMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The created monitor with assigned ID.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TCPMonitor"
+ }
+ },
+ "title": "CreateTCPMonitorResponse",
+ "additionalProperties": false,
+ "description": "CreateTCPMonitorResponse is the response after creating a TCP monitor."
+ },
+ "openstatus.monitor.v1.DNSMonitor": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the monitor (output only for create requests)."
+ },
+ "name": {
+ "type": "string",
+ "examples": ["DNS Resolution Check"],
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Name of the monitor (required, max 256 characters)."
+ },
+ "uri": {
+ "type": "string",
+ "examples": ["example.com"],
+ "title": "uri",
+ "maxLength": 2048,
+ "minLength": 1,
+ "description": "Domain to resolve (required, max 2048 characters)."
+ },
+ "periodicity": {
+ "not": {
+ "enum": ["PERIODICITY_UNSPECIFIED"]
+ },
+ "title": "periodicity",
+ "description": "Check periodicity (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Periodicity"
+ },
+ "timeout": {
+ "type": ["integer", "string"],
+ "title": "timeout",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Timeout in milliseconds (0-120000, defaults to 45000)."
+ },
+ "degradedAt": {
+ "type": ["integer", "string", "null"],
+ "title": "degraded_at",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Latency threshold for degraded status in milliseconds (optional, 0-120000)."
+ },
+ "retry": {
+ "type": ["integer", "string"],
+ "title": "retry",
+ "maximum": 10,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Number of retry attempts (0-10, defaults to 3)."
+ },
+ "recordAssertions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.RecordAssertion"
+ },
+ "title": "record_assertions",
+ "maxItems": 10,
+ "description": "DNS record assertions for validation."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "Description of the monitor (optional)."
+ },
+ "active": {
+ "type": ["boolean", "null"],
+ "title": "active",
+ "description": "Whether the monitor is active (defaults to false)."
+ },
+ "public": {
+ "type": ["boolean", "null"],
+ "title": "public",
+ "description": "Whether the monitor is publicly visible (defaults to false)."
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "title": "regions",
+ "maxItems": 28,
+ "description": "Geographic regions to run checks from."
+ },
+ "openTelemetry": {
+ "title": "open_telemetry",
+ "description": "OpenTelemetry configuration for exporting metrics.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig"
+ },
+ "status": {
+ "title": "status",
+ "description": "Current operational status of the monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.MonitorStatus"
+ },
+ "privateLocationIds": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "readOnly": true
+ },
+ "title": "private_location_ids",
+ "description": "IDs of private locations that run this monitor. Read-only.",
+ "readOnly": true
+ }
+ },
+ "title": "DNSMonitor",
+ "additionalProperties": false,
+ "description": "DNSMonitor defines the configuration for a DNS monitor."
+ },
+ "openstatus.monitor.v1.DeleteMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to delete (required)."
+ }
+ },
+ "title": "DeleteMonitorRequest",
+ "additionalProperties": false,
+ "description": "DeleteMonitorRequest is the request to delete a monitor."
+ },
+ "openstatus.monitor.v1.DeleteMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the deletion was successful."
+ }
+ },
+ "title": "DeleteMonitorResponse",
+ "additionalProperties": false,
+ "description": "DeleteMonitorResponse is the response after deleting a monitor."
+ },
+ "openstatus.monitor.v1.GRPCMonitor": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the monitor (output only for create requests)."
+ },
+ "name": {
+ "type": "string",
+ "examples": ["Checkout gRPC"],
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Name of the monitor (required, max 256 characters)."
+ },
+ "uri": {
+ "type": "string",
+ "examples": ["api.example.com:443"],
+ "title": "uri",
+ "maxLength": 2048,
+ "minLength": 1,
+ "pattern": "^(\\[[0-9a-fA-F:]+\\]|[^:/\\s]+):[0-9]{1,5}$",
+ "description": "Target in \"host:port\" form. IPv6 addresses must be bracketed."
+ },
+ "periodicity": {
+ "not": {
+ "enum": ["PERIODICITY_UNSPECIFIED"]
+ },
+ "title": "periodicity",
+ "description": "Check periodicity (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Periodicity"
+ },
+ "timeout": {
+ "type": ["integer", "string"],
+ "title": "timeout",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Timeout in milliseconds (0-120000, defaults to 45000)."
+ },
+ "degradedAt": {
+ "type": ["integer", "string", "null"],
+ "title": "degraded_at",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Latency threshold for degraded status in milliseconds (optional, 0-120000)."
+ },
+ "retry": {
+ "type": ["integer", "string"],
+ "title": "retry",
+ "maximum": 10,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Number of retry attempts (0-10, defaults to 3)."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "Description of the monitor (optional)."
+ },
+ "active": {
+ "type": ["boolean", "null"],
+ "title": "active",
+ "description": "Whether the monitor is active (defaults to false)."
+ },
+ "public": {
+ "type": ["boolean", "null"],
+ "title": "public",
+ "description": "Whether the monitor is publicly visible (defaults to false)."
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "title": "regions",
+ "maxItems": 28,
+ "description": "Geographic regions to run checks from."
+ },
+ "openTelemetry": {
+ "title": "open_telemetry",
+ "description": "OpenTelemetry configuration for exporting metrics.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig"
+ },
+ "status": {
+ "title": "status",
+ "description": "Current operational status of the monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.MonitorStatus"
+ },
+ "privateLocationIds": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "readOnly": true
+ },
+ "title": "private_location_ids",
+ "description": "IDs of private locations that run this monitor. Read-only.",
+ "readOnly": true
+ },
+ "service": {
+ "type": ["string", "null"],
+ "examples": ["checkout.v1.CheckoutService"],
+ "title": "service",
+ "maxLength": 512,
+ "description": "Service name passed to Health/Check. Empty means overall server health."
+ },
+ "tlsMode": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GRPCTlsMode"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "tls_mode",
+ "description": "How the connection to the target is secured. Defaults to TLS."
+ },
+ "metadata": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Headers"
+ },
+ "title": "metadata",
+ "maxItems": 20,
+ "description": "Metadata sent with the health check request."
+ }
+ },
+ "title": "GRPCMonitor",
+ "additionalProperties": false,
+ "description": "GRPCMonitor defines the configuration for a gRPC health check monitor.\n The probe calls grpc.health.v1.Health/Check on the target."
+ },
+ "openstatus.monitor.v1.GRPCTlsMode": {
+ "type": "string",
+ "title": "GRPCTlsMode",
+ "enum": [
+ "GRPC_TLS_MODE_UNSPECIFIED",
+ "GRPC_TLS_MODE_TLS",
+ "GRPC_TLS_MODE_PLAINTEXT",
+ "GRPC_TLS_MODE_TLS_INSECURE"
+ ],
+ "description": "GRPCTlsMode selects how the probe secures its connection to the target."
+ },
+ "openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to get a response log for (required)."
+ },
+ "logId": {
+ "type": "string",
+ "title": "log_id",
+ "minLength": 1,
+ "description": "Response log ID to retrieve (required)."
+ }
+ },
+ "title": "GetMonitorHTTPResponseLogRequest",
+ "additionalProperties": false,
+ "description": "GetMonitorHTTPResponseLogRequest is the request to get one response log."
+ },
+ "openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse": {
+ "type": "object",
+ "properties": {
+ "log": {
+ "title": "log",
+ "description": "Response log details.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPResponseLogDetail"
+ }
+ },
+ "title": "GetMonitorHTTPResponseLogResponse",
+ "additionalProperties": false,
+ "description": "GetMonitorHTTPResponseLogResponse is the response containing one response log."
+ },
+ "openstatus.monitor.v1.GetMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to retrieve (required)."
+ }
+ },
+ "title": "GetMonitorRequest",
+ "additionalProperties": false,
+ "description": "GetMonitorRequest is the request to get a single monitor by ID."
+ },
+ "openstatus.monitor.v1.GetMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The monitor configuration (one of HTTP, TCP, DNS, ICMP, or gRPC).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.MonitorConfig"
+ }
+ },
+ "title": "GetMonitorResponse",
+ "additionalProperties": false,
+ "description": "GetMonitorResponse is the response containing the monitor."
+ },
+ "openstatus.monitor.v1.GetMonitorStatusRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to get status for (required)."
+ }
+ },
+ "title": "GetMonitorStatusRequest",
+ "additionalProperties": false,
+ "description": "GetMonitorStatusRequest is the request to get the status of all regions for a monitor."
+ },
+ "openstatus.monitor.v1.GetMonitorStatusResponse": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Monitor ID."
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.RegionStatus"
+ },
+ "title": "regions",
+ "description": "Status for each region."
+ }
+ },
+ "title": "GetMonitorStatusResponse",
+ "additionalProperties": false,
+ "description": "GetMonitorStatusResponse is the response containing the status of all regions for a monitor."
+ },
+ "openstatus.monitor.v1.GetMonitorSummaryRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to get summary for (required)."
+ },
+ "timeRange": {
+ "title": "time_range",
+ "description": "Time range for metrics aggregation (defaults to 1 day if unspecified).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TimeRange"
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "title": "regions",
+ "maxItems": 28,
+ "description": "Optional filter by regions. If empty, returns metrics for all regions."
+ }
+ },
+ "title": "GetMonitorSummaryRequest",
+ "additionalProperties": false,
+ "description": "GetMonitorSummaryRequest is the request to get aggregated metrics for a monitor."
+ },
+ "openstatus.monitor.v1.GetMonitorSummaryResponse": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Monitor ID."
+ },
+ "lastPingAt": {
+ "type": "string",
+ "title": "last_ping_at",
+ "description": "Timestamp of the last check in RFC 3339 format."
+ },
+ "totalSuccessful": {
+ "type": ["integer", "string"],
+ "title": "total_successful",
+ "format": "int64",
+ "description": "Total number of successful requests."
+ },
+ "totalDegraded": {
+ "type": ["integer", "string"],
+ "title": "total_degraded",
+ "format": "int64",
+ "description": "Total number of degraded requests."
+ },
+ "totalFailed": {
+ "type": ["integer", "string"],
+ "title": "total_failed",
+ "format": "int64",
+ "description": "Total number of failed requests."
+ },
+ "p50": {
+ "type": ["integer", "string"],
+ "title": "p50",
+ "format": "int64",
+ "description": "50th percentile (median) latency in milliseconds."
+ },
+ "p75": {
+ "type": ["integer", "string"],
+ "title": "p75",
+ "format": "int64",
+ "description": "75th percentile latency in milliseconds."
+ },
+ "p90": {
+ "type": ["integer", "string"],
+ "title": "p90",
+ "format": "int64",
+ "description": "90th percentile latency in milliseconds."
+ },
+ "p95": {
+ "type": ["integer", "string"],
+ "title": "p95",
+ "format": "int64",
+ "description": "95th percentile latency in milliseconds."
+ },
+ "p99": {
+ "type": ["integer", "string"],
+ "title": "p99",
+ "format": "int64",
+ "description": "99th percentile latency in milliseconds."
+ },
+ "timeRange": {
+ "title": "time_range",
+ "description": "Time range used for the metrics.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TimeRange"
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "title": "regions",
+ "description": "Regions included in the metrics."
+ }
+ },
+ "title": "GetMonitorSummaryResponse",
+ "additionalProperties": false,
+ "description": "GetMonitorSummaryResponse is the response containing aggregated metrics for a monitor."
+ },
+ "openstatus.monitor.v1.HTTPMethod": {
+ "type": "string",
+ "title": "HTTPMethod",
+ "enum": [
+ "HTTP_METHOD_UNSPECIFIED",
+ "HTTP_METHOD_GET",
+ "HTTP_METHOD_POST",
+ "HTTP_METHOD_HEAD",
+ "HTTP_METHOD_PUT",
+ "HTTP_METHOD_PATCH",
+ "HTTP_METHOD_DELETE",
+ "HTTP_METHOD_TRACE",
+ "HTTP_METHOD_CONNECT",
+ "HTTP_METHOD_OPTIONS"
+ ],
+ "description": "HTTP methods supported for monitors."
+ },
+ "openstatus.monitor.v1.HTTPMonitor": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the monitor (output only for create requests)."
+ },
+ "name": {
+ "type": "string",
+ "examples": ["Production API Health Check"],
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Name of the monitor (required, max 256 characters)."
+ },
+ "url": {
+ "type": "string",
+ "examples": ["https://api.example.com/health"],
+ "title": "url",
+ "maxLength": 2048,
+ "minLength": 1,
+ "format": "uri",
+ "description": "URL to monitor (required, max 2048 characters)."
+ },
+ "periodicity": {
+ "not": {
+ "enum": ["PERIODICITY_UNSPECIFIED"]
+ },
+ "title": "periodicity",
+ "description": "Check periodicity (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Periodicity"
+ },
+ "method": {
+ "not": {
+ "enum": ["HTTP_METHOD_UNSPECIFIED"]
+ },
+ "title": "method",
+ "description": "HTTP method to use (defaults to GET).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPMethod"
+ },
+ "body": {
+ "type": "string",
+ "examples": ["map[key:value]"],
+ "title": "body",
+ "description": "Request body (optional)."
+ },
+ "timeout": {
+ "type": ["integer", "string"],
+ "title": "timeout",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Timeout in milliseconds (0-120000, defaults to 45000)."
+ },
+ "degradedAt": {
+ "type": ["integer", "string", "null"],
+ "title": "degraded_at",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Latency threshold for degraded status in milliseconds (optional, 0-120000)."
+ },
+ "retry": {
+ "type": ["integer", "string"],
+ "title": "retry",
+ "maximum": 10,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Number of retry attempts (0-10, defaults to 3)."
+ },
+ "followRedirects": {
+ "type": ["boolean", "null"],
+ "title": "follow_redirects",
+ "description": "Whether to follow HTTP redirects (defaults to true when not specified)."
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Headers"
+ },
+ "title": "headers",
+ "maxItems": 20,
+ "description": "Custom headers for the request."
+ },
+ "statusCodeAssertions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.StatusCodeAssertion"
+ },
+ "title": "status_code_assertions",
+ "maxItems": 10,
+ "description": "Status code assertions for the response."
+ },
+ "bodyAssertions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.BodyAssertion"
+ },
+ "title": "body_assertions",
+ "maxItems": 10,
+ "description": "Body content assertions for the response."
+ },
+ "headerAssertions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HeaderAssertion"
+ },
+ "title": "header_assertions",
+ "maxItems": 10,
+ "description": "Header assertions for the response."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "Description of the monitor (optional)."
+ },
+ "active": {
+ "type": ["boolean", "null"],
+ "title": "active",
+ "description": "Whether the monitor is active (defaults to false)."
+ },
+ "public": {
+ "type": ["boolean", "null"],
+ "title": "public",
+ "description": "Whether the monitor is publicly visible (defaults to false)."
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "title": "regions",
+ "maxItems": 28,
+ "description": "Geographic regions to run checks from."
+ },
+ "openTelemetry": {
+ "title": "open_telemetry",
+ "description": "OpenTelemetry configuration for exporting metrics.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig"
+ },
+ "status": {
+ "title": "status",
+ "description": "Current operational status of the monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.MonitorStatus"
+ },
+ "privateLocationIds": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "readOnly": true
+ },
+ "title": "private_location_ids",
+ "description": "IDs of private locations that run this monitor. Read-only.",
+ "readOnly": true
+ }
+ },
+ "title": "HTTPMonitor",
+ "additionalProperties": false,
+ "description": "HTTPMonitor defines the configuration for an HTTP monitor."
+ },
+ "openstatus.monitor.v1.HTTPResponseLogDetail": {
+ "type": "object",
+ "properties": {
+ "log": {
+ "title": "log",
+ "description": "Compact response log fields.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem"
+ },
+ "url": {
+ "type": "string",
+ "title": "url",
+ "description": "Checked URL."
+ },
+ "error": {
+ "type": "boolean",
+ "title": "error",
+ "description": "Whether the check errored."
+ },
+ "message": {
+ "type": ["string", "null"],
+ "title": "message",
+ "description": "Error message, when present."
+ },
+ "headers": {
+ "type": "object",
+ "title": "headers",
+ "additionalProperties": {
+ "type": "string",
+ "title": "value"
+ },
+ "description": "Redacted response headers."
+ },
+ "assertions": {
+ "type": ["string", "null"],
+ "title": "assertions",
+ "description": "Serialized assertions used for the check."
+ }
+ },
+ "title": "HTTPResponseLogDetail",
+ "additionalProperties": false,
+ "description": "HTTPResponseLogDetail contains full response log debugging data."
+ },
+ "openstatus.monitor.v1.HTTPResponseLogDetail.HeadersEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key"
+ },
+ "value": {
+ "type": "string",
+ "title": "value"
+ }
+ },
+ "title": "HeadersEntry",
+ "additionalProperties": false
+ },
+ "openstatus.monitor.v1.HTTPResponseLogListItem": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": ["string", "null"],
+ "title": "id",
+ "description": "Response log ID."
+ },
+ "latency": {
+ "type": "integer",
+ "title": "latency",
+ "format": "int32",
+ "description": "Latency in milliseconds."
+ },
+ "statusCode": {
+ "type": ["integer", "null"],
+ "title": "status_code",
+ "format": "int32",
+ "description": "HTTP status code."
+ },
+ "monitorId": {
+ "type": "string",
+ "title": "monitor_id",
+ "description": "Monitor ID."
+ },
+ "requestStatus": {
+ "title": "request_status",
+ "description": "Request status classification.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPResponseLogRequestStatus"
+ },
+ "region": {
+ "title": "region",
+ "description": "Region where the check ran.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "cronTimestamp": {
+ "type": ["integer", "string"],
+ "title": "cron_timestamp",
+ "format": "int64",
+ "description": "Cron bucket timestamp in Unix milliseconds."
+ },
+ "trigger": {
+ "title": "trigger",
+ "description": "Check trigger.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTrigger"
+ },
+ "timestamp": {
+ "type": ["integer", "string"],
+ "title": "timestamp",
+ "format": "int64",
+ "description": "Response timestamp in Unix milliseconds."
+ },
+ "timing": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPResponseLogTiming"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "timing",
+ "description": "Timing phases."
+ }
+ },
+ "title": "HTTPResponseLogListItem",
+ "additionalProperties": false,
+ "description": "HTTPResponseLogListItem is a compact response log entry."
+ },
+ "openstatus.monitor.v1.HTTPResponseLogPagination": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": "integer",
+ "title": "limit",
+ "format": "int32",
+ "description": "Requested page size."
+ },
+ "offset": {
+ "type": "integer",
+ "title": "offset",
+ "format": "int32",
+ "description": "Requested offset."
+ },
+ "hasMore": {
+ "type": "boolean",
+ "title": "has_more",
+ "description": "Whether more logs are available."
+ },
+ "nextOffset": {
+ "type": ["integer", "null"],
+ "title": "next_offset",
+ "format": "int32",
+ "description": "Next offset if more logs are available."
+ }
+ },
+ "title": "HTTPResponseLogPagination",
+ "additionalProperties": false,
+ "description": "HTTPResponseLogPagination contains offset pagination metadata."
+ },
+ "openstatus.monitor.v1.HTTPResponseLogRequestStatus": {
+ "type": "string",
+ "title": "HTTPResponseLogRequestStatus",
+ "enum": [
+ "HTTP_RESPONSE_LOG_REQUEST_STATUS_UNSPECIFIED",
+ "HTTP_RESPONSE_LOG_REQUEST_STATUS_SUCCESS",
+ "HTTP_RESPONSE_LOG_REQUEST_STATUS_ERROR",
+ "HTTP_RESPONSE_LOG_REQUEST_STATUS_DEGRADED"
+ ],
+ "description": "HTTPResponseLogRequestStatus is the result classification for an HTTP response log."
+ },
+ "openstatus.monitor.v1.HTTPResponseLogTiming": {
+ "type": "object",
+ "properties": {
+ "dns": {
+ "type": "integer",
+ "title": "dns",
+ "format": "int32",
+ "description": "DNS lookup duration."
+ },
+ "connect": {
+ "type": "integer",
+ "title": "connect",
+ "format": "int32",
+ "description": "TCP connection duration."
+ },
+ "tls": {
+ "type": "integer",
+ "title": "tls",
+ "format": "int32",
+ "description": "TLS handshake duration."
+ },
+ "ttfb": {
+ "type": "integer",
+ "title": "ttfb",
+ "format": "int32",
+ "description": "Time to first byte duration."
+ },
+ "transfer": {
+ "type": "integer",
+ "title": "transfer",
+ "format": "int32",
+ "description": "Response transfer duration."
+ }
+ },
+ "title": "HTTPResponseLogTiming",
+ "additionalProperties": false,
+ "description": "HTTPResponseLogTiming contains calculated timing phases in milliseconds."
+ },
+ "openstatus.monitor.v1.HTTPResponseLogTrigger": {
+ "type": "string",
+ "title": "HTTPResponseLogTrigger",
+ "enum": [
+ "HTTP_RESPONSE_LOG_TRIGGER_UNSPECIFIED",
+ "HTTP_RESPONSE_LOG_TRIGGER_CRON",
+ "HTTP_RESPONSE_LOG_TRIGGER_API"
+ ],
+ "description": "HTTPResponseLogTrigger describes what started the monitor check."
+ },
+ "openstatus.monitor.v1.HeaderAssertion": {
+ "type": "object",
+ "properties": {
+ "target": {
+ "type": "string",
+ "title": "target",
+ "description": "Target value to compare against."
+ },
+ "comparator": {
+ "not": {
+ "enum": ["STRING_COMPARATOR_UNSPECIFIED"]
+ },
+ "title": "comparator",
+ "description": "Comparison operation (required, must not be UNSPECIFIED).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.StringComparator"
+ },
+ "key": {
+ "type": "string",
+ "title": "key",
+ "minLength": 1,
+ "description": "Header key to check (required)."
+ }
+ },
+ "title": "HeaderAssertion",
+ "additionalProperties": false,
+ "description": "HeaderAssertion defines an assertion for response headers."
+ },
+ "openstatus.monitor.v1.Headers": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "examples": ["Authorization"],
+ "title": "key",
+ "minLength": 1,
+ "description": "Header name."
+ },
+ "value": {
+ "type": "string",
+ "examples": ["Bearer token123"],
+ "title": "value",
+ "description": "Header value."
+ }
+ },
+ "title": "Headers",
+ "additionalProperties": false,
+ "description": "Headers represents a key-value pair for HTTP headers."
+ },
+ "openstatus.monitor.v1.ICMPMonitor": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the monitor (output only for create requests)."
+ },
+ "name": {
+ "type": "string",
+ "examples": ["Ping Gateway"],
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Name of the monitor (required, max 256 characters)."
+ },
+ "uri": {
+ "type": "string",
+ "examples": ["1.1.1.1"],
+ "title": "uri",
+ "maxLength": 2048,
+ "minLength": 1,
+ "description": "URI to monitor in format \"host or IP\" (required, max 2048 characters)."
+ },
+ "periodicity": {
+ "not": {
+ "enum": ["PERIODICITY_UNSPECIFIED"]
+ },
+ "title": "periodicity",
+ "description": "Check periodicity (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Periodicity"
+ },
+ "timeout": {
+ "type": ["integer", "string"],
+ "title": "timeout",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Timeout in milliseconds (0-120000, defaults to 45000)."
+ },
+ "degradedAt": {
+ "type": ["integer", "string", "null"],
+ "title": "degraded_at",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Latency threshold for degraded status in milliseconds (optional, 0-120000)."
+ },
+ "retry": {
+ "type": ["integer", "string"],
+ "title": "retry",
+ "maximum": 10,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Number of retry attempts (0-10, defaults to 3)."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "Description of the monitor (optional)."
+ },
+ "active": {
+ "type": ["boolean", "null"],
+ "title": "active",
+ "description": "Whether the monitor is active (defaults to false)."
+ },
+ "public": {
+ "type": ["boolean", "null"],
+ "title": "public",
+ "description": "Whether the monitor is publicly visible (defaults to false)."
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "title": "regions",
+ "maxItems": 28,
+ "description": "Geographic regions to run checks from."
+ },
+ "openTelemetry": {
+ "title": "open_telemetry",
+ "description": "OpenTelemetry configuration for exporting metrics.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig"
+ },
+ "status": {
+ "title": "status",
+ "description": "Current operational status of the monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.MonitorStatus"
+ },
+ "privateLocationIds": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "readOnly": true
+ },
+ "title": "private_location_ids",
+ "description": "IDs of private locations that run this monitor. Read-only.",
+ "readOnly": true
+ }
+ },
+ "title": "ICMPMonitor",
+ "additionalProperties": false,
+ "description": "ICMPMonitor defines the configuration for a ICMP monitor."
+ },
+ "openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to list response logs for (required)."
+ },
+ "fromTimestamp": {
+ "type": ["integer", "string", "null"],
+ "title": "from_timestamp",
+ "format": "int64",
+ "description": "Start of the response log window as Unix milliseconds within the 14-day retention window."
+ },
+ "toTimestamp": {
+ "type": ["integer", "string", "null"],
+ "title": "to_timestamp",
+ "format": "int64",
+ "description": "End of the response log window as Unix milliseconds within the 14-day retention window."
+ },
+ "limit": {
+ "type": ["integer", "null"],
+ "title": "limit",
+ "maximum": 100,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Maximum number of logs to return (1-100, defaults to 25)."
+ },
+ "offset": {
+ "type": ["integer", "null"],
+ "title": "offset",
+ "minimum": 0,
+ "format": "int32",
+ "description": "Number of logs to skip for pagination (defaults to 0)."
+ }
+ },
+ "title": "ListMonitorHTTPResponseLogsRequest",
+ "additionalProperties": false,
+ "description": "ListMonitorHTTPResponseLogsRequest is the request to list response logs within the 14-day HTTP response-log window."
+ },
+ "openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse": {
+ "type": "object",
+ "properties": {
+ "logs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPResponseLogListItem"
+ },
+ "title": "logs",
+ "description": "Response logs."
+ },
+ "pagination": {
+ "title": "pagination",
+ "description": "Pagination metadata.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPResponseLogPagination"
+ }
+ },
+ "title": "ListMonitorHTTPResponseLogsResponse",
+ "additionalProperties": false,
+ "description": "ListMonitorHTTPResponseLogsResponse is the response containing response logs."
+ },
+ "openstatus.monitor.v1.ListMonitorsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": ["integer", "null"],
+ "title": "limit",
+ "maximum": 100,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Maximum number of monitors to return (1-100, defaults to 50)."
+ },
+ "offset": {
+ "type": ["integer", "null"],
+ "title": "offset",
+ "minimum": 0,
+ "format": "int32",
+ "description": "Number of monitors to skip for pagination (defaults to 0)."
+ }
+ },
+ "title": "ListMonitorsRequest",
+ "additionalProperties": false,
+ "description": "ListMonitorsRequest is the request to list monitors."
+ },
+ "openstatus.monitor.v1.ListMonitorsResponse": {
+ "type": "object",
+ "properties": {
+ "httpMonitors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPMonitor"
+ },
+ "title": "http_monitors",
+ "description": "HTTP monitors in the workspace."
+ },
+ "tcpMonitors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TCPMonitor"
+ },
+ "title": "tcp_monitors",
+ "description": "TCP monitors in the workspace."
+ },
+ "dnsMonitors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.DNSMonitor"
+ },
+ "title": "dns_monitors",
+ "description": "DNS monitors in the workspace."
+ },
+ "icmpMonitors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ICMPMonitor"
+ },
+ "title": "icmp_monitors",
+ "description": "ICMP monitors in the workspace."
+ },
+ "grpcMonitors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GRPCMonitor"
+ },
+ "title": "grpc_monitors",
+ "description": "gRPC monitors in the workspace."
+ },
+ "totalSize": {
+ "type": "integer",
+ "title": "total_size",
+ "format": "int32",
+ "description": "Total number of monitors across all types."
+ }
+ },
+ "title": "ListMonitorsResponse",
+ "additionalProperties": false,
+ "description": "ListMonitorsResponse is the response containing a list of monitors."
+ },
+ "openstatus.monitor.v1.MonitorConfig": {
+ "type": "object",
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "dns": {
+ "title": "dns",
+ "description": "DNS monitor configuration.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.DNSMonitor"
+ }
+ },
+ "title": "dns",
+ "required": ["dns"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "grpc": {
+ "title": "grpc",
+ "description": "gRPC monitor configuration.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GRPCMonitor"
+ }
+ },
+ "title": "grpc",
+ "required": ["grpc"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "http": {
+ "title": "http",
+ "description": "HTTP monitor configuration.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPMonitor"
+ }
+ },
+ "title": "http",
+ "required": ["http"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "icmp": {
+ "title": "icmp",
+ "description": "ICMP monitor configuration.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ICMPMonitor"
+ }
+ },
+ "title": "icmp",
+ "required": ["icmp"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "tcp": {
+ "title": "tcp",
+ "description": "TCP monitor configuration.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TCPMonitor"
+ }
+ },
+ "title": "tcp",
+ "required": ["tcp"]
+ }
+ ],
+ "title": "MonitorConfig",
+ "additionalProperties": false,
+ "description": "MonitorConfig represents the type-specific configuration for a monitor."
+ },
+ "openstatus.monitor.v1.MonitorStatus": {
+ "type": "string",
+ "title": "MonitorStatus",
+ "enum": [
+ "MONITOR_STATUS_UNSPECIFIED",
+ "MONITOR_STATUS_ACTIVE",
+ "MONITOR_STATUS_DEGRADED",
+ "MONITOR_STATUS_ERROR"
+ ],
+ "description": "MonitorStatus represents the operational status of a monitor."
+ },
+ "openstatus.monitor.v1.NumberComparator": {
+ "type": "string",
+ "title": "NumberComparator",
+ "enum": [
+ "NUMBER_COMPARATOR_UNSPECIFIED",
+ "NUMBER_COMPARATOR_EQUAL",
+ "NUMBER_COMPARATOR_NOT_EQUAL",
+ "NUMBER_COMPARATOR_GREATER_THAN",
+ "NUMBER_COMPARATOR_GREATER_THAN_OR_EQUAL",
+ "NUMBER_COMPARATOR_LESS_THAN",
+ "NUMBER_COMPARATOR_LESS_THAN_OR_EQUAL"
+ ],
+ "description": "NumberComparator defines comparison operations for numeric values."
+ },
+ "openstatus.monitor.v1.OpenTelemetryConfig": {
+ "type": "object",
+ "properties": {
+ "endpoint": {
+ "type": "string",
+ "title": "endpoint",
+ "maxLength": 2048,
+ "description": "OTEL endpoint URL."
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Headers"
+ },
+ "title": "headers",
+ "maxItems": 20,
+ "description": "Custom headers for OTEL requests."
+ }
+ },
+ "title": "OpenTelemetryConfig",
+ "additionalProperties": false,
+ "description": "OpenTelemetry configuration for exporting metrics."
+ },
+ "openstatus.monitor.v1.Periodicity": {
+ "type": "string",
+ "title": "Periodicity",
+ "enum": [
+ "PERIODICITY_UNSPECIFIED",
+ "PERIODICITY_30S",
+ "PERIODICITY_1M",
+ "PERIODICITY_5M",
+ "PERIODICITY_10M",
+ "PERIODICITY_30M",
+ "PERIODICITY_1H"
+ ],
+ "description": "Monitor periodicity options."
+ },
+ "openstatus.monitor.v1.RecordAssertion": {
+ "type": "object",
+ "properties": {
+ "record": {
+ "type": "string",
+ "title": "record",
+ "enum": ["A", "AAAA", "CNAME", "MX", "TXT"],
+ "description": "DNS record type (e.g., \"A\", \"AAAA\", \"CNAME\", \"MX\", \"TXT\")."
+ },
+ "comparator": {
+ "not": {
+ "enum": ["RECORD_COMPARATOR_UNSPECIFIED"]
+ },
+ "title": "comparator",
+ "description": "Comparison operation (required, must not be UNSPECIFIED).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.RecordComparator"
+ },
+ "target": {
+ "type": "string",
+ "title": "target",
+ "description": "Target value to compare against."
+ }
+ },
+ "title": "RecordAssertion",
+ "additionalProperties": false,
+ "description": "RecordAssertion defines an assertion for DNS records."
+ },
+ "openstatus.monitor.v1.RecordComparator": {
+ "type": "string",
+ "title": "RecordComparator",
+ "enum": [
+ "RECORD_COMPARATOR_UNSPECIFIED",
+ "RECORD_COMPARATOR_EQUAL",
+ "RECORD_COMPARATOR_NOT_EQUAL",
+ "RECORD_COMPARATOR_CONTAINS",
+ "RECORD_COMPARATOR_NOT_CONTAINS"
+ ],
+ "description": "RecordComparator defines comparison operations for DNS records."
+ },
+ "openstatus.monitor.v1.Region": {
+ "type": "string",
+ "title": "Region",
+ "enum": [
+ "REGION_UNSPECIFIED",
+ "REGION_FLY_AMS",
+ "REGION_FLY_ARN",
+ "REGION_FLY_BOM",
+ "REGION_FLY_CDG",
+ "REGION_FLY_DFW",
+ "REGION_FLY_EWR",
+ "REGION_FLY_FRA",
+ "REGION_FLY_GRU",
+ "REGION_FLY_IAD",
+ "REGION_FLY_JNB",
+ "REGION_FLY_LAX",
+ "REGION_FLY_LHR",
+ "REGION_FLY_NRT",
+ "REGION_FLY_ORD",
+ "REGION_FLY_SJC",
+ "REGION_FLY_SIN",
+ "REGION_FLY_SYD",
+ "REGION_FLY_YYZ",
+ "REGION_KOYEB_FRA",
+ "REGION_KOYEB_PAR",
+ "REGION_KOYEB_SFO",
+ "REGION_KOYEB_SIN",
+ "REGION_KOYEB_TYO",
+ "REGION_KOYEB_WAS",
+ "REGION_RAILWAY_US_WEST2",
+ "REGION_RAILWAY_US_EAST4",
+ "REGION_RAILWAY_EUROPE_WEST4",
+ "REGION_RAILWAY_ASIA_SOUTHEAST1"
+ ],
+ "description": "Geographic regions where monitors can run checks from."
+ },
+ "openstatus.monitor.v1.RegionStatus": {
+ "type": "object",
+ "properties": {
+ "region": {
+ "title": "region",
+ "description": "The region identifier.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "status": {
+ "title": "status",
+ "description": "The status of the monitor in this region.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.MonitorStatus"
+ }
+ },
+ "title": "RegionStatus",
+ "additionalProperties": false,
+ "description": "RegionStatus represents the status of a monitor in a specific region."
+ },
+ "openstatus.monitor.v1.StatusCodeAssertion": {
+ "type": "object",
+ "properties": {
+ "target": {
+ "type": ["integer", "string"],
+ "title": "target",
+ "maximum": 599,
+ "minimum": 100,
+ "format": "int64",
+ "description": "Target status code to compare against (100-599)."
+ },
+ "comparator": {
+ "not": {
+ "enum": ["NUMBER_COMPARATOR_UNSPECIFIED"]
+ },
+ "title": "comparator",
+ "description": "Comparison operation (required, must not be UNSPECIFIED).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.NumberComparator"
+ }
+ },
+ "title": "StatusCodeAssertion",
+ "additionalProperties": false,
+ "description": "StatusCodeAssertion defines an assertion for HTTP status codes."
+ },
+ "openstatus.monitor.v1.StringComparator": {
+ "type": "string",
+ "title": "StringComparator",
+ "enum": [
+ "STRING_COMPARATOR_UNSPECIFIED",
+ "STRING_COMPARATOR_CONTAINS",
+ "STRING_COMPARATOR_NOT_CONTAINS",
+ "STRING_COMPARATOR_EQUAL",
+ "STRING_COMPARATOR_NOT_EQUAL",
+ "STRING_COMPARATOR_EMPTY",
+ "STRING_COMPARATOR_NOT_EMPTY",
+ "STRING_COMPARATOR_GREATER_THAN",
+ "STRING_COMPARATOR_GREATER_THAN_OR_EQUAL",
+ "STRING_COMPARATOR_LESS_THAN",
+ "STRING_COMPARATOR_LESS_THAN_OR_EQUAL"
+ ],
+ "description": "StringComparator defines comparison operations for string values."
+ },
+ "openstatus.monitor.v1.TCPMonitor": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the monitor (output only for create requests)."
+ },
+ "name": {
+ "type": "string",
+ "examples": ["Database Connection Check"],
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Name of the monitor (required, max 256 characters)."
+ },
+ "uri": {
+ "type": "string",
+ "examples": ["tcp://db.example.com:5432"],
+ "title": "uri",
+ "maxLength": 2048,
+ "minLength": 1,
+ "description": "URI to monitor in format \"host:port\" (required, max 2048 characters)."
+ },
+ "periodicity": {
+ "not": {
+ "enum": ["PERIODICITY_UNSPECIFIED"]
+ },
+ "title": "periodicity",
+ "description": "Check periodicity (required).",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Periodicity"
+ },
+ "timeout": {
+ "type": ["integer", "string"],
+ "title": "timeout",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Timeout in milliseconds (0-120000, defaults to 45000)."
+ },
+ "degradedAt": {
+ "type": ["integer", "string", "null"],
+ "title": "degraded_at",
+ "maximum": 120000,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Latency threshold for degraded status in milliseconds (optional, 0-120000)."
+ },
+ "retry": {
+ "type": ["integer", "string"],
+ "title": "retry",
+ "maximum": 10,
+ "minimum": 0,
+ "format": "int64",
+ "description": "Number of retry attempts (0-10, defaults to 3)."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "Description of the monitor (optional)."
+ },
+ "active": {
+ "type": ["boolean", "null"],
+ "title": "active",
+ "description": "Whether the monitor is active (defaults to false)."
+ },
+ "public": {
+ "type": ["boolean", "null"],
+ "title": "public",
+ "description": "Whether the monitor is publicly visible (defaults to false)."
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.Region"
+ },
+ "title": "regions",
+ "maxItems": 28,
+ "description": "Geographic regions to run checks from."
+ },
+ "openTelemetry": {
+ "title": "open_telemetry",
+ "description": "OpenTelemetry configuration for exporting metrics.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.OpenTelemetryConfig"
+ },
+ "status": {
+ "title": "status",
+ "description": "Current operational status of the monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.MonitorStatus"
+ },
+ "privateLocationIds": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "readOnly": true
+ },
+ "title": "private_location_ids",
+ "description": "IDs of private locations that run this monitor. Read-only.",
+ "readOnly": true
+ }
+ },
+ "title": "TCPMonitor",
+ "additionalProperties": false,
+ "description": "TCPMonitor defines the configuration for a TCP monitor."
+ },
+ "openstatus.monitor.v1.TimeRange": {
+ "type": "string",
+ "title": "TimeRange",
+ "enum": [
+ "TIME_RANGE_UNSPECIFIED",
+ "TIME_RANGE_1D",
+ "TIME_RANGE_7D",
+ "TIME_RANGE_14D"
+ ],
+ "description": "TimeRange represents the time period for metrics aggregation."
+ },
+ "openstatus.monitor.v1.TriggerMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to trigger (required)."
+ }
+ },
+ "title": "TriggerMonitorRequest",
+ "additionalProperties": false,
+ "description": "TriggerMonitorRequest is the request to trigger a monitor check."
+ },
+ "openstatus.monitor.v1.TriggerMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the trigger was successful."
+ }
+ },
+ "title": "TriggerMonitorResponse",
+ "additionalProperties": false,
+ "description": "TriggerMonitorResponse is the response after triggering a monitor."
+ },
+ "openstatus.monitor.v1.UpdateDNSMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to update (required)."
+ },
+ "monitor": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.DNSMonitor"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "monitor",
+ "description": "Updated monitor configuration (all fields optional for partial updates)."
+ }
+ },
+ "title": "UpdateDNSMonitorRequest",
+ "additionalProperties": false,
+ "description": "UpdateDNSMonitorRequest is the request to update an existing DNS monitor."
+ },
+ "openstatus.monitor.v1.UpdateDNSMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The updated monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.DNSMonitor"
+ }
+ },
+ "title": "UpdateDNSMonitorResponse",
+ "additionalProperties": false,
+ "description": "UpdateDNSMonitorResponse is the response after updating a DNS monitor."
+ },
+ "openstatus.monitor.v1.UpdateGRPCMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to update (required)."
+ },
+ "monitor": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GRPCMonitor"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "monitor",
+ "description": "Updated monitor configuration (all fields optional for partial updates)."
+ }
+ },
+ "title": "UpdateGRPCMonitorRequest",
+ "additionalProperties": false,
+ "description": "UpdateGRPCMonitorRequest is the request to update an existing gRPC monitor."
+ },
+ "openstatus.monitor.v1.UpdateGRPCMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The updated monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GRPCMonitor"
+ }
+ },
+ "title": "UpdateGRPCMonitorResponse",
+ "additionalProperties": false,
+ "description": "UpdateGRPCMonitorResponse is the response after updating a gRPC monitor."
+ },
+ "openstatus.monitor.v1.UpdateHTTPMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to update (required)."
+ },
+ "monitor": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPMonitor"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "monitor",
+ "description": "Updated monitor configuration (all fields optional for partial updates)."
+ }
+ },
+ "title": "UpdateHTTPMonitorRequest",
+ "additionalProperties": false,
+ "description": "UpdateHTTPMonitorRequest is the request to update an existing HTTP monitor."
+ },
+ "openstatus.monitor.v1.UpdateHTTPMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The updated monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.HTTPMonitor"
+ }
+ },
+ "title": "UpdateHTTPMonitorResponse",
+ "additionalProperties": false,
+ "description": "UpdateHTTPMonitorResponse is the response after updating an HTTP monitor."
+ },
+ "openstatus.monitor.v1.UpdateICMPMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to update (required)."
+ },
+ "monitor": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ICMPMonitor"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "monitor",
+ "description": "Updated monitor configuration (all fields optional for partial updates)."
+ }
+ },
+ "title": "UpdateICMPMonitorRequest",
+ "additionalProperties": false,
+ "description": "UpdateICMPMonitorRequest is the request to update an existing ICMP monitor."
+ },
+ "openstatus.monitor.v1.UpdateICMPMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The updated monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ICMPMonitor"
+ }
+ },
+ "title": "UpdateICMPMonitorResponse",
+ "additionalProperties": false,
+ "description": "UpdateICMPMonitorResponse is the response after updating an ICMP monitor."
+ },
+ "openstatus.monitor.v1.UpdateTCPMonitorRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Monitor ID to update (required)."
+ },
+ "monitor": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TCPMonitor"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "monitor",
+ "description": "Updated monitor configuration (all fields optional for partial updates)."
+ }
+ },
+ "title": "UpdateTCPMonitorRequest",
+ "additionalProperties": false,
+ "description": "UpdateTCPMonitorRequest is the request to update an existing TCP monitor."
+ },
+ "openstatus.monitor.v1.UpdateTCPMonitorResponse": {
+ "type": "object",
+ "properties": {
+ "monitor": {
+ "title": "monitor",
+ "description": "The updated monitor.",
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TCPMonitor"
+ }
+ },
+ "title": "UpdateTCPMonitorResponse",
+ "additionalProperties": false,
+ "description": "UpdateTCPMonitorResponse is the response after updating a TCP monitor."
+ },
+ "openstatus.notification.v1.CheckNotificationLimitRequest": {
+ "type": "object",
+ "title": "CheckNotificationLimitRequest",
+ "additionalProperties": false,
+ "description": "CheckNotificationLimitRequest is the request to check notification limits."
+ },
+ "openstatus.notification.v1.CheckNotificationLimitResponse": {
+ "type": "object",
+ "properties": {
+ "limitReached": {
+ "type": "boolean",
+ "title": "limit_reached",
+ "description": "Whether the workspace has reached its notification limit."
+ },
+ "currentCount": {
+ "type": "integer",
+ "title": "current_count",
+ "format": "int32",
+ "description": "Current number of notification channels."
+ },
+ "maxCount": {
+ "type": "integer",
+ "title": "max_count",
+ "format": "int32",
+ "description": "Maximum allowed notification channels."
+ }
+ },
+ "title": "CheckNotificationLimitResponse",
+ "additionalProperties": false,
+ "description": "CheckNotificationLimitResponse is the response containing limit information."
+ },
+ "openstatus.notification.v1.CreateNotificationRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "examples": ["Slack Ops Channel"],
+ "title": "name",
+ "minLength": 1,
+ "description": "Display name for the notification channel."
+ },
+ "provider": {
+ "not": {
+ "enum": ["NOTIFICATION_PROVIDER_UNSPECIFIED"]
+ },
+ "title": "provider",
+ "description": "Provider type.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationProvider"
+ },
+ "data": {
+ "title": "data",
+ "description": "Provider-specific configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationData"
+ },
+ "monitorIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "monitor_ids",
+ "description": "IDs of monitors to associate with this notification."
+ }
+ },
+ "title": "CreateNotificationRequest",
+ "required": ["data"],
+ "additionalProperties": false,
+ "description": "CreateNotificationRequest is the request to create a new notification channel."
+ },
+ "openstatus.notification.v1.CreateNotificationResponse": {
+ "type": "object",
+ "properties": {
+ "notification": {
+ "title": "notification",
+ "description": "The created notification channel.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.Notification"
+ }
+ },
+ "title": "CreateNotificationResponse",
+ "additionalProperties": false,
+ "description": "CreateNotificationResponse is the response after creating a notification channel."
+ },
+ "openstatus.notification.v1.DeleteNotificationRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Notification ID to delete (required)."
+ }
+ },
+ "title": "DeleteNotificationRequest",
+ "additionalProperties": false,
+ "description": "DeleteNotificationRequest is the request to delete a notification channel."
+ },
+ "openstatus.notification.v1.DeleteNotificationResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the deletion was successful."
+ }
+ },
+ "title": "DeleteNotificationResponse",
+ "additionalProperties": false,
+ "description": "DeleteNotificationResponse is the response after deleting a notification channel."
+ },
+ "openstatus.notification.v1.DiscordData": {
+ "type": "object",
+ "properties": {
+ "webhookUrl": {
+ "type": "string",
+ "examples": ["https://discord.com/api/webhooks/123/abc"],
+ "title": "webhook_url",
+ "format": "uri",
+ "description": "Discord webhook URL."
+ }
+ },
+ "title": "DiscordData",
+ "additionalProperties": false,
+ "description": "DiscordData contains configuration for Discord notifications."
+ },
+ "openstatus.notification.v1.EmailData": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "examples": ["[email protected]"],
+ "title": "email",
+ "format": "email",
+ "description": "Email address to send notifications to."
+ }
+ },
+ "title": "EmailData",
+ "additionalProperties": false,
+ "description": "EmailData contains configuration for email notifications."
+ },
+ "openstatus.notification.v1.GetNotificationRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Notification ID to retrieve (required)."
+ }
+ },
+ "title": "GetNotificationRequest",
+ "additionalProperties": false,
+ "description": "GetNotificationRequest is the request to get a notification channel."
+ },
+ "openstatus.notification.v1.GetNotificationResponse": {
+ "type": "object",
+ "properties": {
+ "notification": {
+ "title": "notification",
+ "description": "The notification channel.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.Notification"
+ }
+ },
+ "title": "GetNotificationResponse",
+ "additionalProperties": false,
+ "description": "GetNotificationResponse is the response containing the notification channel."
+ },
+ "openstatus.notification.v1.GoogleChatData": {
+ "type": "object",
+ "properties": {
+ "webhookUrl": {
+ "type": "string",
+ "title": "webhook_url",
+ "format": "uri",
+ "description": "Google Chat webhook URL."
+ }
+ },
+ "title": "GoogleChatData",
+ "additionalProperties": false,
+ "description": "GoogleChatData contains configuration for Google Chat notifications."
+ },
+ "openstatus.notification.v1.GrafanaOncallData": {
+ "type": "object",
+ "properties": {
+ "webhookUrl": {
+ "type": "string",
+ "title": "webhook_url",
+ "format": "uri",
+ "description": "Grafana OnCall webhook URL."
+ }
+ },
+ "title": "GrafanaOncallData",
+ "additionalProperties": false,
+ "description": "GrafanaOncallData contains configuration for Grafana OnCall notifications."
+ },
+ "openstatus.notification.v1.ListNotificationsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": ["integer", "null"],
+ "title": "limit",
+ "maximum": 100,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Maximum number of notifications to return (1-100, defaults to 50)."
+ },
+ "offset": {
+ "type": ["integer", "null"],
+ "title": "offset",
+ "minimum": 0,
+ "format": "int32",
+ "description": "Number of notifications to skip for pagination (defaults to 0)."
+ }
+ },
+ "title": "ListNotificationsRequest",
+ "additionalProperties": false,
+ "description": "ListNotificationsRequest is the request to list notification channels."
+ },
+ "openstatus.notification.v1.ListNotificationsResponse": {
+ "type": "object",
+ "properties": {
+ "notifications": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationSummary"
+ },
+ "title": "notifications",
+ "description": "Notification channel summaries."
+ },
+ "totalSize": {
+ "type": "integer",
+ "title": "total_size",
+ "format": "int32",
+ "description": "Total number of notification channels."
+ }
+ },
+ "title": "ListNotificationsResponse",
+ "additionalProperties": false,
+ "description": "ListNotificationsResponse is the response containing notification channels."
+ },
+ "openstatus.notification.v1.MsTeamsData": {
+ "type": "object",
+ "properties": {
+ "webhookUrl": {
+ "type": "string",
+ "examples": [
+ "https://prod-00.westeurope.logic.azure.com:443/workflows/abc/triggers/manual/paths/invoke"
+ ],
+ "title": "webhook_url",
+ "format": "uri",
+ "description": "Microsoft Teams webhook URL (Power Automate Workflows)."
+ }
+ },
+ "title": "MsTeamsData",
+ "additionalProperties": false,
+ "description": "MsTeamsData contains configuration for Microsoft Teams notifications."
+ },
+ "openstatus.notification.v1.Notification": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the notification."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "description": "Display name for the notification channel."
+ },
+ "provider": {
+ "title": "provider",
+ "description": "Provider type.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationProvider"
+ },
+ "data": {
+ "title": "data",
+ "description": "Provider-specific configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationData"
+ },
+ "monitorIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "monitor_ids",
+ "description": "IDs of monitors associated with this notification."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the notification was created (RFC 3339)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the notification was last updated (RFC 3339)."
+ }
+ },
+ "title": "Notification",
+ "additionalProperties": false,
+ "description": "Notification represents a notification channel with full details."
+ },
+ "openstatus.notification.v1.NotificationData": {
+ "type": "object",
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "discord": {
+ "title": "discord",
+ "description": "Discord configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.DiscordData"
+ }
+ },
+ "title": "discord",
+ "required": ["discord"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "email": {
+ "title": "email",
+ "description": "Email configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.EmailData"
+ }
+ },
+ "title": "email",
+ "required": ["email"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "googleChat": {
+ "title": "google_chat",
+ "description": "Google Chat configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.GoogleChatData"
+ }
+ },
+ "title": "google_chat",
+ "required": ["googleChat"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "grafanaOncall": {
+ "title": "grafana_oncall",
+ "description": "Grafana OnCall configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.GrafanaOncallData"
+ }
+ },
+ "title": "grafana_oncall",
+ "required": ["grafanaOncall"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "msTeams": {
+ "title": "ms_teams",
+ "description": "Microsoft Teams configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.MsTeamsData"
+ }
+ },
+ "title": "ms_teams",
+ "required": ["msTeams"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "ntfy": {
+ "title": "ntfy",
+ "description": "Ntfy configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.NtfyData"
+ }
+ },
+ "title": "ntfy",
+ "required": ["ntfy"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "opsgenie": {
+ "title": "opsgenie",
+ "description": "Opsgenie configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.OpsgenieData"
+ }
+ },
+ "title": "opsgenie",
+ "required": ["opsgenie"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "pagerduty": {
+ "title": "pagerduty",
+ "description": "PagerDuty configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.PagerDutyData"
+ }
+ },
+ "title": "pagerduty",
+ "required": ["pagerduty"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "slack": {
+ "title": "slack",
+ "description": "Slack configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.SlackData"
+ }
+ },
+ "title": "slack",
+ "required": ["slack"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "sms": {
+ "title": "sms",
+ "description": "SMS configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.SmsData"
+ }
+ },
+ "title": "sms",
+ "required": ["sms"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "telegram": {
+ "title": "telegram",
+ "description": "Telegram configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.TelegramData"
+ }
+ },
+ "title": "telegram",
+ "required": ["telegram"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "webhook": {
+ "title": "webhook",
+ "description": "Webhook configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.WebhookData"
+ }
+ },
+ "title": "webhook",
+ "required": ["webhook"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "whatsapp": {
+ "title": "whatsapp",
+ "description": "WhatsApp configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.WhatsappData"
+ }
+ },
+ "title": "whatsapp",
+ "required": ["whatsapp"]
+ }
+ ],
+ "title": "NotificationData",
+ "additionalProperties": false,
+ "description": "NotificationData is a union of provider-specific configuration."
+ },
+ "openstatus.notification.v1.NotificationProvider": {
+ "type": "string",
+ "title": "NotificationProvider",
+ "enum": [
+ "NOTIFICATION_PROVIDER_UNSPECIFIED",
+ "NOTIFICATION_PROVIDER_DISCORD",
+ "NOTIFICATION_PROVIDER_EMAIL",
+ "NOTIFICATION_PROVIDER_GOOGLE_CHAT",
+ "NOTIFICATION_PROVIDER_GRAFANA_ONCALL",
+ "NOTIFICATION_PROVIDER_NTFY",
+ "NOTIFICATION_PROVIDER_PAGERDUTY",
+ "NOTIFICATION_PROVIDER_OPSGENIE",
+ "NOTIFICATION_PROVIDER_SLACK",
+ "NOTIFICATION_PROVIDER_SMS",
+ "NOTIFICATION_PROVIDER_TELEGRAM",
+ "NOTIFICATION_PROVIDER_WEBHOOK",
+ "NOTIFICATION_PROVIDER_WHATSAPP",
+ "NOTIFICATION_PROVIDER_MS_TEAMS"
+ ],
+ "description": "NotificationProvider represents the supported notification channel types."
+ },
+ "openstatus.notification.v1.NotificationSummary": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the notification."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "description": "Display name for the notification channel."
+ },
+ "provider": {
+ "title": "provider",
+ "description": "Provider type.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationProvider"
+ },
+ "monitorCount": {
+ "type": "integer",
+ "title": "monitor_count",
+ "format": "int32",
+ "description": "Number of monitors associated with this notification."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the notification was created (RFC 3339)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the notification was last updated (RFC 3339)."
+ }
+ },
+ "title": "NotificationSummary",
+ "additionalProperties": false,
+ "description": "NotificationSummary represents a notification channel summary for list responses."
+ },
+ "openstatus.notification.v1.NtfyData": {
+ "type": "object",
+ "properties": {
+ "topic": {
+ "type": "string",
+ "examples": ["openstatus-alerts"],
+ "title": "topic",
+ "minLength": 1,
+ "description": "Ntfy topic to publish to."
+ },
+ "serverUrl": {
+ "type": "string",
+ "title": "server_url",
+ "description": "Ntfy server URL (defaults to https://ntfy.sh)."
+ },
+ "token": {
+ "type": ["string", "null"],
+ "title": "token",
+ "description": "Optional authentication token."
+ }
+ },
+ "title": "NtfyData",
+ "additionalProperties": false,
+ "description": "NtfyData contains configuration for Ntfy notifications."
+ },
+ "openstatus.notification.v1.OpsgenieData": {
+ "type": "object",
+ "properties": {
+ "apiKey": {
+ "type": "string",
+ "title": "api_key",
+ "minLength": 1,
+ "description": "Opsgenie API key."
+ },
+ "region": {
+ "title": "region",
+ "description": "Opsgenie region.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.OpsgenieRegion"
+ }
+ },
+ "title": "OpsgenieData",
+ "additionalProperties": false,
+ "description": "OpsgenieData contains configuration for Opsgenie notifications."
+ },
+ "openstatus.notification.v1.OpsgenieRegion": {
+ "type": "string",
+ "title": "OpsgenieRegion",
+ "enum": [
+ "OPSGENIE_REGION_UNSPECIFIED",
+ "OPSGENIE_REGION_US",
+ "OPSGENIE_REGION_EU"
+ ],
+ "description": "OpsgenieRegion represents the Opsgenie API region."
+ },
+ "openstatus.notification.v1.PagerDutyData": {
+ "type": "object",
+ "properties": {
+ "integrationKey": {
+ "type": "string",
+ "examples": ["a1b2c3d4e5f6g7h8i9j0"],
+ "title": "integration_key",
+ "minLength": 1,
+ "description": "PagerDuty integration key."
+ }
+ },
+ "title": "PagerDutyData",
+ "additionalProperties": false,
+ "description": "PagerDutyData contains configuration for PagerDuty notifications."
+ },
+ "openstatus.notification.v1.SendTestNotificationRequest": {
+ "type": "object",
+ "properties": {
+ "provider": {
+ "not": {
+ "enum": ["NOTIFICATION_PROVIDER_UNSPECIFIED"]
+ },
+ "title": "provider",
+ "description": "Provider type.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationProvider"
+ },
+ "data": {
+ "title": "data",
+ "description": "Provider-specific configuration.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationData"
+ }
+ },
+ "title": "SendTestNotificationRequest",
+ "required": ["data"],
+ "additionalProperties": false,
+ "description": "SendTestNotificationRequest is the request to send a test notification."
+ },
+ "openstatus.notification.v1.SendTestNotificationResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the test was successful."
+ },
+ "errorMessage": {
+ "type": ["string", "null"],
+ "title": "error_message",
+ "description": "Optional error message if the test failed."
+ }
+ },
+ "title": "SendTestNotificationResponse",
+ "additionalProperties": false,
+ "description": "SendTestNotificationResponse is the response after sending a test notification."
+ },
+ "openstatus.notification.v1.SlackData": {
+ "type": "object",
+ "properties": {
+ "webhookUrl": {
+ "type": "string",
+ "examples": ["https://hooks.slack.com/services/T00/B00/xxx"],
+ "title": "webhook_url",
+ "format": "uri",
+ "description": "Slack webhook URL."
+ }
+ },
+ "title": "SlackData",
+ "additionalProperties": false,
+ "description": "SlackData contains configuration for Slack notifications."
+ },
+ "openstatus.notification.v1.SmsData": {
+ "type": "object",
+ "properties": {
+ "phoneNumber": {
+ "type": "string",
+ "examples": ["+14155551234"],
+ "title": "phone_number",
+ "minLength": 1,
+ "description": "Phone number to send SMS to."
+ }
+ },
+ "title": "SmsData",
+ "additionalProperties": false,
+ "description": "SmsData contains configuration for SMS notifications."
+ },
+ "openstatus.notification.v1.TelegramData": {
+ "type": "object",
+ "properties": {
+ "chatId": {
+ "type": "string",
+ "examples": ["-1001234567890"],
+ "title": "chat_id",
+ "minLength": 1,
+ "description": "Telegram chat ID."
+ }
+ },
+ "title": "TelegramData",
+ "additionalProperties": false,
+ "description": "TelegramData contains configuration for Telegram notifications."
+ },
+ "openstatus.notification.v1.UpdateNotificationRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "Notification ID to update (required)."
+ },
+ "name": {
+ "type": ["string", "null"],
+ "title": "name",
+ "description": "Updated display name."
+ },
+ "data": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.notification.v1.NotificationData"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "data",
+ "description": "Updated provider-specific configuration."
+ },
+ "monitorIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "monitor_ids",
+ "description": "Updated monitor IDs to associate."
+ },
+ "updateMonitorIds": {
+ "type": ["boolean", "null"],
+ "title": "update_monitor_ids",
+ "description": "Set to true to update monitor associations.\n When true, monitor_ids replaces the existing list (empty clears all).\n When false or unset, monitor_ids is ignored and existing associations are preserved."
+ }
+ },
+ "title": "UpdateNotificationRequest",
+ "additionalProperties": false,
+ "description": "UpdateNotificationRequest is the request to update a notification channel."
+ },
+ "openstatus.notification.v1.UpdateNotificationResponse": {
+ "type": "object",
+ "properties": {
+ "notification": {
+ "title": "notification",
+ "description": "The updated notification channel.",
+ "$ref": "#/components/schemas/openstatus.notification.v1.Notification"
+ }
+ },
+ "title": "UpdateNotificationResponse",
+ "additionalProperties": false,
+ "description": "UpdateNotificationResponse is the response after updating a notification channel."
+ },
+ "openstatus.notification.v1.WebhookData": {
+ "type": "object",
+ "properties": {
+ "endpoint": {
+ "type": "string",
+ "examples": ["https://api.example.com/webhooks/openstatus"],
+ "title": "endpoint",
+ "format": "uri",
+ "description": "Webhook endpoint URL."
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.WebhookHeader"
+ },
+ "title": "headers",
+ "description": "Optional custom headers."
+ }
+ },
+ "title": "WebhookData",
+ "additionalProperties": false,
+ "description": "WebhookData contains configuration for custom webhook notifications."
+ },
+ "openstatus.notification.v1.WebhookHeader": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key",
+ "minLength": 1,
+ "description": "Header name."
+ },
+ "value": {
+ "type": "string",
+ "title": "value",
+ "description": "Header value."
+ }
+ },
+ "title": "WebhookHeader",
+ "additionalProperties": false,
+ "description": "WebhookHeader represents a custom header for webhook requests."
+ },
+ "openstatus.notification.v1.WhatsappData": {
+ "type": "object",
+ "properties": {
+ "phoneNumber": {
+ "type": "string",
+ "title": "phone_number",
+ "minLength": 1,
+ "description": "Phone number to send WhatsApp messages to."
+ }
+ },
+ "title": "WhatsappData",
+ "additionalProperties": false,
+ "description": "WhatsappData contains configuration for WhatsApp notifications."
+ },
+ "openstatus.private_location.v1.CreatePrivateLocationRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "examples": ["eu-west-agent"],
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Display name for the private location (required, 1-256 characters)."
+ },
+ "monitorIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "monitor_ids",
+ "description": "IDs of monitors this private location should run (optional)."
+ },
+ "metadata": {
+ "type": "object",
+ "title": "metadata",
+ "maxProperties": 20,
+ "additionalProperties": {
+ "type": "string",
+ "title": "value",
+ "maxLength": 256
+ },
+ "description": "User-defined key/value labels (optional, up to 20 entries)."
+ }
+ },
+ "title": "CreatePrivateLocationRequest",
+ "additionalProperties": false,
+ "description": "CreatePrivateLocationRequest is the request to create a new private location."
+ },
+ "openstatus.private_location.v1.CreatePrivateLocationRequest.MetadataEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key"
+ },
+ "value": {
+ "type": "string",
+ "title": "value"
+ }
+ },
+ "title": "MetadataEntry",
+ "additionalProperties": false
+ },
+ "openstatus.private_location.v1.CreatePrivateLocationResponse": {
+ "type": "object",
+ "properties": {
+ "privateLocation": {
+ "title": "private_location",
+ "description": "The created private location, including its generated agent token.",
+ "$ref": "#/components/schemas/openstatus.private_location.v1.PrivateLocation"
+ }
+ },
+ "title": "CreatePrivateLocationResponse",
+ "additionalProperties": false,
+ "description": "CreatePrivateLocationResponse is the response after creating a private location."
+ },
+ "openstatus.private_location.v1.DeletePrivateLocationRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the private location to delete (required)."
+ }
+ },
+ "title": "DeletePrivateLocationRequest",
+ "additionalProperties": false,
+ "description": "DeletePrivateLocationRequest is the request to delete a private location."
+ },
+ "openstatus.private_location.v1.DeletePrivateLocationResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the deletion was successful."
+ }
+ },
+ "title": "DeletePrivateLocationResponse",
+ "additionalProperties": false,
+ "description": "DeletePrivateLocationResponse is the response after deleting a private location."
+ },
+ "openstatus.private_location.v1.GetPrivateLocationRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the private location to retrieve (required)."
+ }
+ },
+ "title": "GetPrivateLocationRequest",
+ "additionalProperties": false,
+ "description": "GetPrivateLocationRequest is the request to get a private location by ID."
+ },
+ "openstatus.private_location.v1.GetPrivateLocationResponse": {
+ "type": "object",
+ "properties": {
+ "privateLocation": {
+ "title": "private_location",
+ "description": "The requested private location.",
+ "$ref": "#/components/schemas/openstatus.private_location.v1.PrivateLocation"
+ }
+ },
+ "title": "GetPrivateLocationResponse",
+ "additionalProperties": false,
+ "description": "GetPrivateLocationResponse is the response containing the private location."
+ },
+ "openstatus.private_location.v1.ListPrivateLocationsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": ["integer", "null"],
+ "title": "limit",
+ "maximum": 100,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Maximum number of private locations to return (1-100, defaults to 50)."
+ },
+ "offset": {
+ "type": ["integer", "null"],
+ "title": "offset",
+ "minimum": 0,
+ "format": "int32",
+ "description": "Number of private locations to skip for pagination (defaults to 0)."
+ }
+ },
+ "title": "ListPrivateLocationsRequest",
+ "additionalProperties": false,
+ "description": "ListPrivateLocationsRequest is the request to list private locations."
+ },
+ "openstatus.private_location.v1.ListPrivateLocationsResponse": {
+ "type": "object",
+ "properties": {
+ "privateLocations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.PrivateLocationSummary"
+ },
+ "title": "private_locations",
+ "description": "List of private locations."
+ },
+ "totalSize": {
+ "type": "integer",
+ "title": "total_size",
+ "format": "int32",
+ "description": "Total number of private locations in the workspace."
+ }
+ },
+ "title": "ListPrivateLocationsResponse",
+ "additionalProperties": false,
+ "description": "ListPrivateLocationsResponse is the response containing private location summaries."
+ },
+ "openstatus.private_location.v1.PrivateLocation": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the private location."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "description": "Display name for the private location."
+ },
+ "token": {
+ "type": "string",
+ "title": "token",
+ "description": "Agent credential. Generated by the server on creation and used by the\n agent to authenticate; treat it as a secret."
+ },
+ "monitorIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "monitor_ids",
+ "description": "IDs of monitors this private location runs."
+ },
+ "lastSeenAt": {
+ "type": "string",
+ "title": "last_seen_at",
+ "description": "Last time the agent reported a result (RFC 3339), empty if it never has."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the private location was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the private location was last updated (RFC 3339 format)."
+ },
+ "metadata": {
+ "type": "object",
+ "title": "metadata",
+ "additionalProperties": {
+ "type": "string",
+ "title": "value"
+ },
+ "description": "User-defined key/value labels attached to this private location."
+ },
+ "status": {
+ "title": "status",
+ "description": "Computed health of the agent. Read-only.",
+ "$ref": "#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus"
+ }
+ },
+ "title": "PrivateLocation",
+ "additionalProperties": false,
+ "description": "PrivateLocation represents a self-hosted checker agent with full details."
+ },
+ "openstatus.private_location.v1.PrivateLocation.MetadataEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key"
+ },
+ "value": {
+ "type": "string",
+ "title": "value"
+ }
+ },
+ "title": "MetadataEntry",
+ "additionalProperties": false
+ },
+ "openstatus.private_location.v1.PrivateLocationStatus": {
+ "type": "string",
+ "title": "PrivateLocationStatus",
+ "enum": [
+ "PRIVATE_LOCATION_STATUS_UNSPECIFIED",
+ "PRIVATE_LOCATION_STATUS_ACTIVE",
+ "PRIVATE_LOCATION_STATUS_ERROR"
+ ],
+ "description": "PrivateLocationStatus is the computed health of a private location, derived\n from the agent heartbeat. Read-only — it cannot be set through the API."
+ },
+ "openstatus.private_location.v1.PrivateLocationSummary": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the private location."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "description": "Display name for the private location."
+ },
+ "monitorCount": {
+ "type": "integer",
+ "title": "monitor_count",
+ "format": "int32",
+ "description": "Number of monitors this private location runs."
+ },
+ "lastSeenAt": {
+ "type": "string",
+ "title": "last_seen_at",
+ "description": "Last time the agent reported a result (RFC 3339), empty if it never has."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the private location was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the private location was last updated (RFC 3339 format)."
+ },
+ "status": {
+ "title": "status",
+ "description": "Computed health of the agent. Read-only.",
+ "$ref": "#/components/schemas/openstatus.private_location.v1.PrivateLocationStatus"
+ },
+ "metadata": {
+ "type": "object",
+ "title": "metadata",
+ "additionalProperties": {
+ "type": "string",
+ "title": "value"
+ },
+ "description": "User-defined key/value labels attached to this private location."
+ }
+ },
+ "title": "PrivateLocationSummary",
+ "additionalProperties": false,
+ "description": "PrivateLocationSummary represents metadata for a private location (used in\n list responses). The agent token is intentionally omitted."
+ },
+ "openstatus.private_location.v1.PrivateLocationSummary.MetadataEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key"
+ },
+ "value": {
+ "type": "string",
+ "title": "value"
+ }
+ },
+ "title": "MetadataEntry",
+ "additionalProperties": false
+ },
+ "openstatus.private_location.v1.UpdatePrivateLocationRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the private location to update (required)."
+ },
+ "name": {
+ "type": ["string", "null"],
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "New display name for the private location (optional)."
+ },
+ "monitorIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "monitor_ids",
+ "description": "New list of monitor IDs. Only applied when update_monitor_ids is true."
+ },
+ "updateMonitorIds": {
+ "type": ["boolean", "null"],
+ "title": "update_monitor_ids",
+ "description": "When true, monitor_ids replaces the current associations (an empty list\n clears all). When false or unset, monitor_ids is ignored and existing\n associations are preserved."
+ },
+ "metadata": {
+ "type": "object",
+ "title": "metadata",
+ "maxProperties": 20,
+ "additionalProperties": {
+ "type": "string",
+ "title": "value",
+ "maxLength": 256
+ },
+ "description": "New key/value labels. Only applied when update_metadata is true."
+ },
+ "updateMetadata": {
+ "type": ["boolean", "null"],
+ "title": "update_metadata",
+ "description": "When true, metadata replaces the current labels (an empty map clears all).\n When false or unset, metadata is ignored and existing labels are preserved."
+ }
+ },
+ "title": "UpdatePrivateLocationRequest",
+ "additionalProperties": false,
+ "description": "UpdatePrivateLocationRequest is the request to update a private location."
+ },
+ "openstatus.private_location.v1.UpdatePrivateLocationRequest.MetadataEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key"
+ },
+ "value": {
+ "type": "string",
+ "title": "value"
+ }
+ },
+ "title": "MetadataEntry",
+ "additionalProperties": false
+ },
+ "openstatus.private_location.v1.UpdatePrivateLocationResponse": {
+ "type": "object",
+ "properties": {
+ "privateLocation": {
+ "title": "private_location",
+ "description": "The updated private location.",
+ "$ref": "#/components/schemas/openstatus.private_location.v1.PrivateLocation"
+ }
+ },
+ "title": "UpdatePrivateLocationResponse",
+ "additionalProperties": false,
+ "description": "UpdatePrivateLocationResponse is the response after updating a private location."
+ },
+ "openstatus.status_page.v1.AddMonitorComponentRequest": {
+ "type": "object",
+ "properties": {
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "ID of the status page to add the component to (required)."
+ },
+ "monitorId": {
+ "type": "string",
+ "title": "monitor_id",
+ "minLength": 1,
+ "description": "ID of the monitor to associate with this component (required)."
+ },
+ "name": {
+ "type": ["string", "null"],
+ "title": "name",
+ "maxLength": 256,
+ "description": "Display name for the component (optional, defaults to monitor name)."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "Description of the component (optional)."
+ },
+ "order": {
+ "type": ["integer", "null"],
+ "title": "order",
+ "format": "int32",
+ "description": "Display order of the component (optional)."
+ },
+ "groupId": {
+ "type": ["string", "null"],
+ "title": "group_id",
+ "description": "ID of the group to add this component to (optional)."
+ }
+ },
+ "title": "AddMonitorComponentRequest",
+ "additionalProperties": false,
+ "description": "AddMonitorComponentRequest is the request to add a monitor-based component to a status page."
+ },
+ "openstatus.status_page.v1.AddMonitorComponentResponse": {
+ "type": "object",
+ "properties": {
+ "component": {
+ "title": "component",
+ "description": "The created component.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponent"
+ }
+ },
+ "title": "AddMonitorComponentResponse",
+ "additionalProperties": false,
+ "description": "AddMonitorComponentResponse is the response after adding a monitor component."
+ },
+ "openstatus.status_page.v1.AddStaticComponentRequest": {
+ "type": "object",
+ "properties": {
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "ID of the status page to add the component to (required)."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Display name for the component (required)."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "Description of the component (optional)."
+ },
+ "order": {
+ "type": ["integer", "null"],
+ "title": "order",
+ "format": "int32",
+ "description": "Display order of the component (optional)."
+ },
+ "groupId": {
+ "type": ["string", "null"],
+ "title": "group_id",
+ "description": "ID of the group to add this component to (optional)."
+ }
+ },
+ "title": "AddStaticComponentRequest",
+ "additionalProperties": false,
+ "description": "AddStaticComponentRequest is the request to add a static component to a status page."
+ },
+ "openstatus.status_page.v1.AddStaticComponentResponse": {
+ "type": "object",
+ "properties": {
+ "component": {
+ "title": "component",
+ "description": "The created component.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponent"
+ }
+ },
+ "title": "AddStaticComponentResponse",
+ "additionalProperties": false,
+ "description": "AddStaticComponentResponse is the response after adding a static component."
+ },
+ "openstatus.status_page.v1.ComponentDayBucket": {
+ "type": "object",
+ "properties": {
+ "day": {
+ "type": "string",
+ "title": "day",
+ "description": "Day in RFC 3339 format (UTC midnight)."
+ },
+ "count": {
+ "type": ["integer", "string"],
+ "title": "count",
+ "format": "int64",
+ "description": "Total checks that day."
+ },
+ "ok": {
+ "type": ["integer", "string"],
+ "title": "ok",
+ "format": "int64",
+ "description": "Successful checks."
+ },
+ "degraded": {
+ "type": ["integer", "string"],
+ "title": "degraded",
+ "format": "int64",
+ "description": "Degraded checks."
+ },
+ "error": {
+ "type": ["integer", "string"],
+ "title": "error",
+ "format": "int64",
+ "description": "Failed checks."
+ },
+ "status": {
+ "title": "status",
+ "description": "Convenience resolved status for the day.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ComponentDayStatus"
+ },
+ "impact": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.PageComponentImpact"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "impact",
+ "description": "Worst status-report impact overlapping the day (absent when none)."
+ }
+ },
+ "title": "ComponentDayBucket",
+ "additionalProperties": false,
+ "description": "ComponentDayBucket is one day of status data for a component."
+ },
+ "openstatus.status_page.v1.ComponentDayStatus": {
+ "type": "string",
+ "title": "ComponentDayStatus",
+ "enum": [
+ "COMPONENT_DAY_STATUS_UNSPECIFIED",
+ "COMPONENT_DAY_STATUS_OPERATIONAL",
+ "COMPONENT_DAY_STATUS_DEGRADED",
+ "COMPONENT_DAY_STATUS_DOWN",
+ "COMPONENT_DAY_STATUS_MAINTENANCE",
+ "COMPONENT_DAY_STATUS_EMPTY"
+ ],
+ "description": "ComponentDayStatus is the resolved status of a component on a given day."
+ },
+ "openstatus.status_page.v1.ComponentEvent": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Identifier of the underlying event."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "description": "Human-readable name (incident \"Downtime\", maintenance / report title)."
+ },
+ "type": {
+ "title": "type",
+ "description": "Kind of event.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ComponentEventType"
+ },
+ "status": {
+ "title": "status",
+ "description": "Projected status this event contributes.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ComponentEventStatus"
+ },
+ "from": {
+ "type": "string",
+ "title": "from",
+ "description": "Start time (RFC 3339)."
+ },
+ "to": {
+ "type": ["string", "null"],
+ "title": "to",
+ "description": "End time (RFC 3339); absent while the event is ongoing."
+ },
+ "impact": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.PageComponentImpact"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "impact",
+ "description": "Worst impact over the event (reports only; absent otherwise)."
+ }
+ },
+ "title": "ComponentEvent",
+ "additionalProperties": false,
+ "description": "ComponentEvent is a single incident / maintenance / report affecting a component."
+ },
+ "openstatus.status_page.v1.ComponentEventStatus": {
+ "type": "string",
+ "title": "ComponentEventStatus",
+ "enum": [
+ "COMPONENT_EVENT_STATUS_UNSPECIFIED",
+ "COMPONENT_EVENT_STATUS_OPERATIONAL",
+ "COMPONENT_EVENT_STATUS_DEGRADED",
+ "COMPONENT_EVENT_STATUS_DOWN",
+ "COMPONENT_EVENT_STATUS_MAINTENANCE"
+ ],
+ "description": "ComponentEventStatus is the projected status an event contributes."
+ },
+ "openstatus.status_page.v1.ComponentEventType": {
+ "type": "string",
+ "title": "ComponentEventType",
+ "enum": [
+ "COMPONENT_EVENT_TYPE_UNSPECIFIED",
+ "COMPONENT_EVENT_TYPE_MAINTENANCE",
+ "COMPONENT_EVENT_TYPE_INCIDENT",
+ "COMPONENT_EVENT_TYPE_REPORT"
+ ],
+ "description": "ComponentEventType is the kind of timeline event affecting a component."
+ },
+ "openstatus.status_page.v1.ComponentStatus": {
+ "type": "object",
+ "properties": {
+ "componentId": {
+ "type": "string",
+ "title": "component_id",
+ "description": "ID of the component."
+ },
+ "status": {
+ "title": "status",
+ "description": "Current status of the component.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.OverallStatus"
+ }
+ },
+ "title": "ComponentStatus",
+ "additionalProperties": false,
+ "description": "ComponentStatus represents the status of a single component."
+ },
+ "openstatus.status_page.v1.CreateComponentGroupRequest": {
+ "type": "object",
+ "properties": {
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "ID of the status page to create the group in (required)."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Display name for the group (required)."
+ },
+ "defaultOpen": {
+ "type": ["boolean", "null"],
+ "title": "default_open",
+ "description": "Whether the group should be expanded by default on the status page (optional, defaults to false)."
+ }
+ },
+ "title": "CreateComponentGroupRequest",
+ "additionalProperties": false,
+ "description": "CreateComponentGroupRequest is the request to create a new component group."
+ },
+ "openstatus.status_page.v1.CreateComponentGroupResponse": {
+ "type": "object",
+ "properties": {
+ "group": {
+ "title": "group",
+ "description": "The created component group.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponentGroup"
+ }
+ },
+ "title": "CreateComponentGroupResponse",
+ "additionalProperties": false,
+ "description": "CreateComponentGroupResponse is the response after creating a component group."
+ },
+ "openstatus.status_page.v1.CreatePageSubscriptionRequest": {
+ "type": "object",
+ "allOf": [
+ {
+ "properties": {
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "ID of the status page (required)."
+ },
+ "name": {
+ "type": ["string", "null"],
+ "title": "name",
+ "maxLength": 255,
+ "description": "Optional human-readable label."
+ },
+ "componentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "component_ids",
+ "description": "Component scope. Empty = entire page."
+ }
+ }
+ },
+ {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "emailChannel": {
+ "title": "email_channel",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.EmailChannel"
+ }
+ },
+ "title": "email_channel",
+ "required": ["emailChannel"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "webhookChannel": {
+ "title": "webhook_channel",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.WebhookChannel"
+ }
+ },
+ "title": "webhook_channel",
+ "required": ["webhookChannel"]
+ }
+ ]
+ }
+ ],
+ "title": "CreatePageSubscriptionRequest",
+ "additionalProperties": false,
+ "description": "CreatePageSubscriptionRequest is the request to add a vendor-managed subscriber to a status page."
+ },
+ "openstatus.status_page.v1.CreatePageSubscriptionResponse": {
+ "type": "object",
+ "properties": {
+ "subscriber": {
+ "title": "subscriber",
+ "description": "The created subscriber.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageSubscriber"
+ }
+ },
+ "title": "CreatePageSubscriptionResponse",
+ "additionalProperties": false,
+ "description": "CreatePageSubscriptionResponse is the response after creating a vendor-managed subscription."
+ },
+ "openstatus.status_page.v1.CreateStatusPageRequest": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "examples": ["Acme Corp Status"],
+ "title": "title",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Title of the status page (required)."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "Description of the status page (optional)."
+ },
+ "slug": {
+ "type": "string",
+ "examples": ["my-status-page"],
+ "title": "slug",
+ "maxLength": 256,
+ "minLength": 1,
+ "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
+ "description": "URL-friendly slug for the status page (required). Must be lowercase alphanumeric with hyphens."
+ },
+ "homepageUrl": {
+ "type": ["string", "null"],
+ "examples": ["https://www.example.com"],
+ "title": "homepage_url",
+ "description": "URL to the homepage (optional)."
+ },
+ "contactUrl": {
+ "type": ["string", "null"],
+ "title": "contact_url",
+ "description": "URL to the contact page (optional)."
+ },
+ "defaultLocale": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.Locale"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "default_locale",
+ "description": "Default locale for the status page (optional, defaults to EN)."
+ },
+ "locales": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.Locale"
+ },
+ "title": "locales",
+ "description": "Enabled locales for the status page (optional)."
+ },
+ "icon": {
+ "type": ["string", "null"],
+ "title": "icon",
+ "maxLength": 1024,
+ "description": "Icon URL for the status page (optional)."
+ },
+ "customDomain": {
+ "type": ["string", "null"],
+ "title": "custom_domain",
+ "maxLength": 256,
+ "description": "Custom domain for the status page (optional)."
+ },
+ "theme": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageTheme"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "theme",
+ "description": "Visual theme for the status page (optional, defaults to SYSTEM)."
+ },
+ "accessType": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageAccessType"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "access_type",
+ "description": "Access type for the status page (optional, defaults to PUBLIC)."
+ },
+ "password": {
+ "type": ["string", "null"],
+ "title": "password",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "Password for the status page (required when access_type is PASSWORD_PROTECTED)."
+ },
+ "authEmailDomains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "auth_email_domains",
+ "description": "Email domains allowed to access the page (used when access_type is AUTHENTICATED)."
+ },
+ "allowIndex": {
+ "type": ["boolean", "null"],
+ "title": "allow_index",
+ "description": "Whether search engines are allowed to index this status page (optional, defaults to true)."
+ },
+ "allowedIpRanges": {
+ "type": ["string", "null"],
+ "title": "allowed_ip_ranges",
+ "description": "Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED)."
+ },
+ "customTheme": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CustomTheme"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "custom_theme",
+ "description": "Per-mode CSS variable overrides merged over the theme (optional).\n Only supported variable names are accepted. Requires the custom-theme plan feature."
+ }
+ },
+ "title": "CreateStatusPageRequest",
+ "additionalProperties": false,
+ "description": "CreateStatusPageRequest is the request to create a new status page."
+ },
+ "openstatus.status_page.v1.CreateStatusPageResponse": {
+ "type": "object",
+ "properties": {
+ "statusPage": {
+ "title": "status_page",
+ "description": "The created status page.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.StatusPage"
+ }
+ },
+ "title": "CreateStatusPageResponse",
+ "additionalProperties": false,
+ "description": "CreateStatusPageResponse is the response after creating a status page."
+ },
+ "openstatus.status_page.v1.CustomTheme": {
+ "type": "object",
+ "properties": {
+ "light": {
+ "type": "object",
+ "title": "light",
+ "additionalProperties": {
+ "type": "string",
+ "title": "value"
+ },
+ "description": "CSS variable overrides applied in light mode, keyed by variable name (e.g. \"--primary\": \"hsl(24 94% 50%)\")."
+ },
+ "dark": {
+ "type": "object",
+ "title": "dark",
+ "additionalProperties": {
+ "type": "string",
+ "title": "value"
+ },
+ "description": "CSS variable overrides applied in dark mode, keyed by variable name."
+ }
+ },
+ "title": "CustomTheme",
+ "additionalProperties": false,
+ "description": "CustomTheme holds per-mode CSS variable overrides merged over the page theme."
+ },
+ "openstatus.status_page.v1.CustomTheme.DarkEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key"
+ },
+ "value": {
+ "type": "string",
+ "title": "value"
+ }
+ },
+ "title": "DarkEntry",
+ "additionalProperties": false
+ },
+ "openstatus.status_page.v1.CustomTheme.LightEntry": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key"
+ },
+ "value": {
+ "type": "string",
+ "title": "value"
+ }
+ },
+ "title": "LightEntry",
+ "additionalProperties": false
+ },
+ "openstatus.status_page.v1.DeleteComponentGroupRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the component group to delete (required)."
+ }
+ },
+ "title": "DeleteComponentGroupRequest",
+ "additionalProperties": false,
+ "description": "DeleteComponentGroupRequest is the request to delete a component group."
+ },
+ "openstatus.status_page.v1.DeleteComponentGroupResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the deletion was successful."
+ }
+ },
+ "title": "DeleteComponentGroupResponse",
+ "additionalProperties": false,
+ "description": "DeleteComponentGroupResponse is the response after deleting a component group."
+ },
+ "openstatus.status_page.v1.DeleteStatusPageRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the status page to delete (required)."
+ }
+ },
+ "title": "DeleteStatusPageRequest",
+ "additionalProperties": false,
+ "description": "DeleteStatusPageRequest is the request to delete a status page."
+ },
+ "openstatus.status_page.v1.DeleteStatusPageResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the deletion was successful."
+ }
+ },
+ "title": "DeleteStatusPageResponse",
+ "additionalProperties": false,
+ "description": "DeleteStatusPageResponse is the response after deleting a status page."
+ },
+ "openstatus.status_page.v1.EmailChannel": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "title": "email",
+ "format": "email",
+ "description": "Email address of the subscriber (required)."
+ }
+ },
+ "title": "EmailChannel",
+ "additionalProperties": false,
+ "description": "EmailChannel carries the email-channel fields for CreatePageSubscription."
+ },
+ "openstatus.status_page.v1.GetOverallStatusRequest": {
+ "type": "object",
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "ID of the status page."
+ }
+ },
+ "title": "id",
+ "required": ["id"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "slug": {
+ "type": "string",
+ "title": "slug",
+ "description": "Slug of the status page."
+ }
+ },
+ "title": "slug",
+ "required": ["slug"]
+ }
+ ],
+ "title": "GetOverallStatusRequest",
+ "additionalProperties": false,
+ "description": "GetOverallStatusRequest is the request to get the overall status of a status page."
+ },
+ "openstatus.status_page.v1.GetOverallStatusResponse": {
+ "type": "object",
+ "properties": {
+ "overallStatus": {
+ "title": "overall_status",
+ "description": "Aggregated status across all components.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.OverallStatus"
+ },
+ "componentStatuses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ComponentStatus"
+ },
+ "title": "component_statuses",
+ "description": "Status of individual components."
+ }
+ },
+ "title": "GetOverallStatusResponse",
+ "additionalProperties": false,
+ "description": "GetOverallStatusResponse is the response containing the overall status and individual component statuses."
+ },
+ "openstatus.status_page.v1.GetPageComponentDailySummaryRequest": {
+ "type": "object",
+ "allOf": [
+ {
+ "properties": {
+ "componentIds": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "minLength": 1
+ },
+ "title": "component_ids",
+ "description": "Restrict the result to these component ids (optional, defaults to all components)."
+ },
+ "days": {
+ "type": ["integer", "null"],
+ "title": "days",
+ "maximum": 45,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Number of days to return (1-45, defaults to 45 if unspecified)."
+ }
+ }
+ },
+ {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "ID of the status page."
+ }
+ },
+ "title": "id",
+ "required": ["id"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "slug": {
+ "type": "string",
+ "title": "slug",
+ "description": "Slug of the status page."
+ }
+ },
+ "title": "slug",
+ "required": ["slug"]
+ }
+ ]
+ }
+ ],
+ "title": "GetPageComponentDailySummaryRequest",
+ "additionalProperties": false,
+ "description": "GetPageComponentDailySummaryRequest is the request for per-component daily summaries."
+ },
+ "openstatus.status_page.v1.GetPageComponentDailySummaryResponse": {
+ "type": "object",
+ "properties": {
+ "components": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponentDailySummary"
+ },
+ "title": "components",
+ "description": "Per-component daily summaries, in page order."
+ }
+ },
+ "title": "GetPageComponentDailySummaryResponse",
+ "additionalProperties": false,
+ "description": "GetPageComponentDailySummaryResponse is the response containing per-component summaries."
+ },
+ "openstatus.status_page.v1.GetPageComponentRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the component to retrieve (required)."
+ }
+ },
+ "title": "GetPageComponentRequest",
+ "additionalProperties": false,
+ "description": "GetPageComponentRequest is the request to fetch a single component by ID."
+ },
+ "openstatus.status_page.v1.GetPageComponentResponse": {
+ "type": "object",
+ "properties": {
+ "component": {
+ "title": "component",
+ "description": "The requested component.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponent"
+ }
+ },
+ "title": "GetPageComponentResponse",
+ "additionalProperties": false,
+ "description": "GetPageComponentResponse is the response containing the component."
+ },
+ "openstatus.status_page.v1.GetStatusPageContentRequest": {
+ "type": "object",
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "ID of the status page."
+ }
+ },
+ "title": "id",
+ "required": ["id"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "slug": {
+ "type": "string",
+ "title": "slug",
+ "description": "Slug of the status page."
+ }
+ },
+ "title": "slug",
+ "required": ["slug"]
+ }
+ ],
+ "title": "GetStatusPageContentRequest",
+ "additionalProperties": false,
+ "description": "GetStatusPageContentRequest is the request to get the full content of a status page."
+ },
+ "openstatus.status_page.v1.GetStatusPageContentResponse": {
+ "type": "object",
+ "properties": {
+ "statusPage": {
+ "title": "status_page",
+ "description": "The status page details.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.StatusPage"
+ },
+ "components": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponent"
+ },
+ "title": "components",
+ "description": "Components on the status page."
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponentGroup"
+ },
+ "title": "groups",
+ "description": "Component groups on the status page."
+ },
+ "statusReports": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReport"
+ },
+ "title": "status_reports",
+ "description": "Active and recent status reports."
+ },
+ "maintenances": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary"
+ },
+ "title": "maintenances",
+ "description": "Scheduled maintenances."
+ }
+ },
+ "title": "GetStatusPageContentResponse",
+ "additionalProperties": false,
+ "description": "GetStatusPageContentResponse is the response containing the full status page content."
+ },
+ "openstatus.status_page.v1.GetStatusPageOverviewRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the status page (required, workspace-scoped)."
+ }
+ },
+ "title": "GetStatusPageOverviewRequest",
+ "additionalProperties": false,
+ "description": "GetStatusPageOverviewRequest requests the full overview of a status page by id."
+ },
+ "openstatus.status_page.v1.GetStatusPageOverviewResponse": {
+ "type": "object",
+ "properties": {
+ "statusPage": {
+ "title": "status_page",
+ "description": "The status page details.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.StatusPage"
+ },
+ "configuration": {
+ "title": "configuration",
+ "description": "Rich rendering configuration of the page.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageConfiguration"
+ },
+ "components": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponent"
+ },
+ "title": "components",
+ "description": "Components on the status page."
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponentGroup"
+ },
+ "title": "groups",
+ "description": "Component groups on the status page."
+ },
+ "statusReports": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReport"
+ },
+ "title": "status_reports",
+ "description": "Active and recent status reports."
+ },
+ "maintenances": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.MaintenanceSummary"
+ },
+ "title": "maintenances",
+ "description": "Scheduled maintenances."
+ },
+ "overallStatus": {
+ "title": "overall_status",
+ "description": "Aggregated status across all components.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.OverallStatus"
+ },
+ "componentStatuses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ComponentStatus"
+ },
+ "title": "component_statuses",
+ "description": "Status of individual components."
+ }
+ },
+ "title": "GetStatusPageOverviewResponse",
+ "additionalProperties": false,
+ "description": "GetStatusPageOverviewResponse bundles all data for a single status page."
+ },
+ "openstatus.status_page.v1.GetStatusPageRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the status page to retrieve (required)."
+ }
+ },
+ "title": "GetStatusPageRequest",
+ "additionalProperties": false,
+ "description": "GetStatusPageRequest is the request to get a status page by ID."
+ },
+ "openstatus.status_page.v1.GetStatusPageResponse": {
+ "type": "object",
+ "properties": {
+ "statusPage": {
+ "title": "status_page",
+ "description": "The requested status page.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.StatusPage"
+ }
+ },
+ "title": "GetStatusPageResponse",
+ "additionalProperties": false,
+ "description": "GetStatusPageResponse is the response containing the status page."
+ },
+ "openstatus.status_page.v1.ListStatusPagesRequest": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": ["integer", "null"],
+ "title": "limit",
+ "maximum": 100,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Maximum number of pages to return (1-100, defaults to 50)."
+ },
+ "offset": {
+ "type": ["integer", "null"],
+ "title": "offset",
+ "minimum": 0,
+ "format": "int32",
+ "description": "Number of pages to skip for pagination (defaults to 0)."
+ }
+ },
+ "title": "ListStatusPagesRequest",
+ "additionalProperties": false,
+ "description": "ListStatusPagesRequest is the request to list status pages."
+ },
+ "openstatus.status_page.v1.ListStatusPagesResponse": {
+ "type": "object",
+ "properties": {
+ "statusPages": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.StatusPageSummary"
+ },
+ "title": "status_pages",
+ "description": "List of status pages (metadata only)."
+ },
+ "totalSize": {
+ "type": "integer",
+ "title": "total_size",
+ "format": "int32",
+ "description": "Total number of status pages."
+ }
+ },
+ "title": "ListStatusPagesResponse",
+ "additionalProperties": false,
+ "description": "ListStatusPagesResponse is the response containing status page summaries."
+ },
+ "openstatus.status_page.v1.ListSubscribersRequest": {
+ "type": "object",
+ "properties": {
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "ID of the status page to list subscribers for (required)."
+ },
+ "limit": {
+ "type": ["integer", "null"],
+ "title": "limit",
+ "maximum": 100,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Maximum number of subscribers to return (1-100, defaults to 50)."
+ },
+ "offset": {
+ "type": ["integer", "null"],
+ "title": "offset",
+ "minimum": 0,
+ "format": "int32",
+ "description": "Number of subscribers to skip for pagination (defaults to 0)."
+ },
+ "includeUnsubscribed": {
+ "type": ["boolean", "null"],
+ "title": "include_unsubscribed",
+ "description": "Whether to include unsubscribed users (defaults to false)."
+ }
+ },
+ "title": "ListSubscribersRequest",
+ "additionalProperties": false,
+ "description": "ListSubscribersRequest is the request to list subscribers of a status page."
+ },
+ "openstatus.status_page.v1.ListSubscribersResponse": {
+ "type": "object",
+ "properties": {
+ "subscribers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageSubscriber"
+ },
+ "title": "subscribers",
+ "description": "List of subscribers."
+ },
+ "totalSize": {
+ "type": "integer",
+ "title": "total_size",
+ "format": "int32",
+ "description": "Total number of subscribers matching the filter."
+ }
+ },
+ "title": "ListSubscribersResponse",
+ "additionalProperties": false,
+ "description": "ListSubscribersResponse is the response containing status page subscribers."
+ },
+ "openstatus.status_page.v1.Locale": {
+ "type": "string",
+ "title": "Locale",
+ "enum": [
+ "LOCALE_UNSPECIFIED",
+ "LOCALE_EN",
+ "LOCALE_FR",
+ "LOCALE_DE",
+ "LOCALE_TR",
+ "LOCALE_HI",
+ "LOCALE_KO"
+ ],
+ "description": "Locale defines the supported languages for a status page."
+ },
+ "openstatus.status_page.v1.OverallStatus": {
+ "type": "string",
+ "title": "OverallStatus",
+ "enum": [
+ "OVERALL_STATUS_UNSPECIFIED",
+ "OVERALL_STATUS_OPERATIONAL",
+ "OVERALL_STATUS_DEGRADED",
+ "OVERALL_STATUS_PARTIAL_OUTAGE",
+ "OVERALL_STATUS_MAJOR_OUTAGE",
+ "OVERALL_STATUS_MAINTENANCE",
+ "OVERALL_STATUS_UNKNOWN"
+ ],
+ "description": "OverallStatus represents the aggregated status of all components on a page."
+ },
+ "openstatus.status_page.v1.PageAccessType": {
+ "type": "string",
+ "title": "PageAccessType",
+ "enum": [
+ "PAGE_ACCESS_TYPE_UNSPECIFIED",
+ "PAGE_ACCESS_TYPE_PUBLIC",
+ "PAGE_ACCESS_TYPE_PASSWORD_PROTECTED",
+ "PAGE_ACCESS_TYPE_AUTHENTICATED",
+ "PAGE_ACCESS_TYPE_IP_RESTRICTED"
+ ],
+ "description": "PageAccessType defines who can access the status page."
+ },
+ "openstatus.status_page.v1.PageBarType": {
+ "type": "string",
+ "title": "PageBarType",
+ "enum": [
+ "PAGE_BAR_TYPE_UNSPECIFIED",
+ "PAGE_BAR_TYPE_ABSOLUTE",
+ "PAGE_BAR_TYPE_MANUAL"
+ ],
+ "description": "PageBarType mirrors page.configuration.type (how the status bar is computed)."
+ },
+ "openstatus.status_page.v1.PageComponent": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the component."
+ },
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "description": "ID of the status page this component belongs to."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "description": "Display name of the component."
+ },
+ "description": {
+ "type": "string",
+ "title": "description",
+ "description": "Description of the component (optional)."
+ },
+ "type": {
+ "title": "type",
+ "description": "Type of the component (monitor or static).",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponentType"
+ },
+ "monitorId": {
+ "type": "string",
+ "title": "monitor_id",
+ "description": "ID of the monitor if type is MONITOR (optional)."
+ },
+ "order": {
+ "type": "integer",
+ "title": "order",
+ "format": "int32",
+ "description": "Display order of the component."
+ },
+ "groupId": {
+ "type": "string",
+ "title": "group_id",
+ "description": "ID of the group this component belongs to (optional)."
+ },
+ "groupOrder": {
+ "type": "integer",
+ "title": "group_order",
+ "format": "int32",
+ "description": "Order within the group if grouped."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the component was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the component was last updated (RFC 3339 format)."
+ }
+ },
+ "title": "PageComponent",
+ "additionalProperties": false,
+ "description": "PageComponent represents a component displayed on a status page."
+ },
+ "openstatus.status_page.v1.PageComponentDailySummary": {
+ "type": "object",
+ "properties": {
+ "componentId": {
+ "type": "string",
+ "title": "component_id",
+ "description": "ID of the component."
+ },
+ "type": {
+ "title": "type",
+ "description": "Component type (monitor or static).",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponentType"
+ },
+ "monitorId": {
+ "type": ["string", "null"],
+ "title": "monitor_id",
+ "description": "Monitor id backing the component (absent for static components)."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "description": "Display name of the component."
+ },
+ "buckets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ComponentDayBucket"
+ },
+ "title": "buckets",
+ "description": "Per-day buckets, oldest first."
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ComponentEvent"
+ },
+ "title": "events",
+ "description": "Events affecting the component within the window."
+ }
+ },
+ "title": "PageComponentDailySummary",
+ "additionalProperties": false,
+ "description": "PageComponentDailySummary is the per-day buckets + event timeline for one component."
+ },
+ "openstatus.status_page.v1.PageComponentGroup": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the group."
+ },
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "description": "ID of the status page this group belongs to."
+ },
+ "name": {
+ "type": "string",
+ "title": "name",
+ "description": "Display name of the group."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the group was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the group was last updated (RFC 3339 format)."
+ },
+ "defaultOpen": {
+ "type": "boolean",
+ "title": "default_open",
+ "description": "Whether the group should be expanded by default on the status page."
+ }
+ },
+ "title": "PageComponentGroup",
+ "additionalProperties": false,
+ "description": "PageComponentGroup represents a group of components on a status page."
+ },
+ "openstatus.status_page.v1.PageComponentType": {
+ "type": "string",
+ "title": "PageComponentType",
+ "enum": [
+ "PAGE_COMPONENT_TYPE_UNSPECIFIED",
+ "PAGE_COMPONENT_TYPE_MONITOR",
+ "PAGE_COMPONENT_TYPE_STATIC"
+ ],
+ "description": "PageComponentType defines the type of a component on a status page."
+ },
+ "openstatus.status_page.v1.PageConfiguration": {
+ "type": "object",
+ "properties": {
+ "metricType": {
+ "title": "metric_type",
+ "description": "Which metric the status bars represent (configuration.value).",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageMetricType"
+ },
+ "barType": {
+ "title": "bar_type",
+ "description": "How the status bar is computed (configuration.type).",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageBarType"
+ },
+ "showUptime": {
+ "type": "boolean",
+ "title": "show_uptime",
+ "description": "Whether to show the uptime percentage (configuration.uptime)."
+ },
+ "themeKey": {
+ "type": "string",
+ "title": "theme_key",
+ "description": "Theme key from the theme store (configuration.theme), e.g. \"default\".\n Free-form string rather than an enum because the theme catalog is dynamic."
+ },
+ "days": {
+ "type": "integer",
+ "title": "days",
+ "format": "int32",
+ "description": "Number of uptime-bar days rendered on the page (configuration.days): 30 or 45."
+ }
+ },
+ "title": "PageConfiguration",
+ "additionalProperties": false,
+ "description": "PageConfiguration is the rich rendering config stored in page.configuration."
+ },
+ "openstatus.status_page.v1.PageMetricType": {
+ "type": "string",
+ "title": "PageMetricType",
+ "enum": [
+ "PAGE_METRIC_TYPE_UNSPECIFIED",
+ "PAGE_METRIC_TYPE_DURATION",
+ "PAGE_METRIC_TYPE_REQUESTS",
+ "PAGE_METRIC_TYPE_MANUAL"
+ ],
+ "description": "PageMetricType mirrors page.configuration.value (which metric the status bars represent)."
+ },
+ "openstatus.status_page.v1.PageSubscriber": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the subscriber."
+ },
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "description": "ID of the status page the user is subscribed to."
+ },
+ "email": {
+ "type": "string",
+ "title": "email",
+ "description": "Email address of the subscriber (empty for webhook channels)."
+ },
+ "acceptedAt": {
+ "type": "string",
+ "title": "accepted_at",
+ "description": "Timestamp when the subscription was accepted/confirmed (RFC 3339 format, optional)."
+ },
+ "unsubscribedAt": {
+ "type": "string",
+ "title": "unsubscribed_at",
+ "description": "Timestamp when the user unsubscribed (RFC 3339 format, optional)."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the subscription was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the subscription was last updated (RFC 3339 format)."
+ },
+ "source": {
+ "title": "source",
+ "description": "How the subscription was created. Vendor-added rows skip verification.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.SubscriberSource"
+ },
+ "name": {
+ "type": ["string", "null"],
+ "title": "name",
+ "description": "Optional human-readable label (e.g. \"Supabase #incidents\")."
+ },
+ "channelType": {
+ "type": "string",
+ "title": "channel_type",
+ "description": "Channel type: \"email\" or \"webhook\"."
+ },
+ "webhookUrl": {
+ "type": ["string", "null"],
+ "title": "webhook_url",
+ "description": "Webhook URL (populated only for channel_type = \"webhook\")."
+ },
+ "channelConfig": {
+ "type": ["string", "null"],
+ "title": "channel_config",
+ "description": "JSON-encoded channel config (e.g. custom headers). Populated for webhook channels."
+ },
+ "componentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "component_ids",
+ "description": "IDs of components this subscription is scoped to. Empty = entire page."
+ }
+ },
+ "title": "PageSubscriber",
+ "additionalProperties": false,
+ "description": "PageSubscriber represents a subscriber to a status page."
+ },
+ "openstatus.status_page.v1.PageTheme": {
+ "type": "string",
+ "title": "PageTheme",
+ "enum": [
+ "PAGE_THEME_UNSPECIFIED",
+ "PAGE_THEME_SYSTEM",
+ "PAGE_THEME_LIGHT",
+ "PAGE_THEME_DARK"
+ ],
+ "description": "PageTheme defines the visual theme of the status page."
+ },
+ "openstatus.status_page.v1.RemoveComponentRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the component to remove (required)."
+ }
+ },
+ "title": "RemoveComponentRequest",
+ "additionalProperties": false,
+ "description": "RemoveComponentRequest is the request to remove a component from a status page."
+ },
+ "openstatus.status_page.v1.RemoveComponentResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the removal was successful."
+ }
+ },
+ "title": "RemoveComponentResponse",
+ "additionalProperties": false,
+ "description": "RemoveComponentResponse is the response after removing a component."
+ },
+ "openstatus.status_page.v1.StatusPage": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the status page."
+ },
+ "title": {
+ "type": "string",
+ "title": "title",
+ "description": "Title of the status page."
+ },
+ "description": {
+ "type": "string",
+ "title": "description",
+ "description": "Description of the status page."
+ },
+ "slug": {
+ "type": "string",
+ "examples": ["acme-corp"],
+ "title": "slug",
+ "description": "URL-friendly slug for the status page."
+ },
+ "customDomain": {
+ "type": "string",
+ "examples": ["status.example.com"],
+ "title": "custom_domain",
+ "description": "Custom domain for the status page (optional)."
+ },
+ "published": {
+ "type": "boolean",
+ "title": "published",
+ "description": "Whether the status page is published and visible."
+ },
+ "accessType": {
+ "title": "access_type",
+ "description": "Access type for the status page.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageAccessType"
+ },
+ "theme": {
+ "title": "theme",
+ "description": "Visual theme for the status page.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageTheme"
+ },
+ "homepageUrl": {
+ "type": "string",
+ "title": "homepage_url",
+ "description": "URL to the homepage (optional)."
+ },
+ "contactUrl": {
+ "type": "string",
+ "title": "contact_url",
+ "description": "URL to the contact page (optional)."
+ },
+ "icon": {
+ "type": "string",
+ "title": "icon",
+ "description": "Icon URL for the status page (optional)."
+ },
+ "createdAt": {
+ "type": "string",
+ "examples": ["2024-01-15T09:00:00Z"],
+ "title": "created_at",
+ "description": "Timestamp when the page was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "examples": ["2024-06-20T14:30:00Z"],
+ "title": "updated_at",
+ "description": "Timestamp when the page was last updated (RFC 3339 format)."
+ },
+ "defaultLocale": {
+ "title": "default_locale",
+ "description": "Default locale for the status page.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.Locale"
+ },
+ "locales": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.Locale"
+ },
+ "title": "locales",
+ "description": "Enabled locales for the status page."
+ },
+ "password": {
+ "type": "string",
+ "title": "password",
+ "description": "Password for the status page (only set when access_type is PASSWORD_PROTECTED)."
+ },
+ "authEmailDomains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "auth_email_domains",
+ "description": "Email domains allowed to access the page (only set when access_type is AUTHENTICATED)."
+ },
+ "allowIndex": {
+ "type": "boolean",
+ "title": "allow_index",
+ "description": "Whether search engines are allowed to index this status page."
+ },
+ "allowedIpRanges": {
+ "type": "string",
+ "title": "allowed_ip_ranges",
+ "description": "Comma-separated IPv4 CIDR ranges (only set when access_type is IP_RESTRICTED)."
+ },
+ "customTheme": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CustomTheme"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "custom_theme",
+ "description": "Per-mode CSS variable overrides merged over the theme (only set when configured)."
+ }
+ },
+ "title": "StatusPage",
+ "additionalProperties": false,
+ "description": "StatusPage represents a full status page with all details."
+ },
+ "openstatus.status_page.v1.StatusPageSummary": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the status page."
+ },
+ "title": {
+ "type": "string",
+ "title": "title",
+ "description": "Title of the status page."
+ },
+ "slug": {
+ "type": "string",
+ "title": "slug",
+ "description": "URL-friendly slug for the status page."
+ },
+ "published": {
+ "type": "boolean",
+ "title": "published",
+ "description": "Whether the status page is published and visible."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the page was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the page was last updated (RFC 3339 format)."
+ },
+ "customDomain": {
+ "type": "string",
+ "examples": ["status.example.com"],
+ "title": "custom_domain",
+ "description": "Custom domain for the status page (optional)."
+ }
+ },
+ "title": "StatusPageSummary",
+ "additionalProperties": false,
+ "description": "StatusPageSummary represents metadata for a status page (used in list responses)."
+ },
+ "openstatus.status_page.v1.SubscribeToPageRequest": {
+ "type": "object",
+ "properties": {
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "ID of the status page to subscribe to (required)."
+ },
+ "email": {
+ "type": "string",
+ "examples": ["[email protected]"],
+ "title": "email",
+ "format": "email",
+ "description": "Email address to subscribe (required)."
+ }
+ },
+ "title": "SubscribeToPageRequest",
+ "additionalProperties": false,
+ "description": "SubscribeToPageRequest is the request to subscribe an email to a status page."
+ },
+ "openstatus.status_page.v1.SubscribeToPageResponse": {
+ "type": "object",
+ "properties": {
+ "subscriber": {
+ "title": "subscriber",
+ "description": "The created subscriber.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageSubscriber"
+ }
+ },
+ "title": "SubscribeToPageResponse",
+ "additionalProperties": false,
+ "description": "SubscribeToPageResponse is the response after subscribing to a status page."
+ },
+ "openstatus.status_page.v1.SubscriberSource": {
+ "type": "string",
+ "title": "SubscriberSource",
+ "enum": [
+ "SUBSCRIBER_SOURCE_UNSPECIFIED",
+ "SUBSCRIBER_SOURCE_SELF_SIGNUP",
+ "SUBSCRIBER_SOURCE_VENDOR",
+ "SUBSCRIBER_SOURCE_IMPORT"
+ ],
+ "description": "SubscriberSource indicates how the subscription was created."
+ },
+ "openstatus.status_page.v1.UnsubscribeFromPageRequest": {
+ "type": "object",
+ "allOf": [
+ {
+ "properties": {
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "ID of the status page to unsubscribe from (required)."
+ }
+ }
+ },
+ {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "title": "email",
+ "description": "Email address to unsubscribe."
+ }
+ },
+ "title": "email",
+ "required": ["email"]
+ },
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Subscriber ID."
+ }
+ },
+ "title": "id",
+ "required": ["id"]
+ }
+ ]
+ }
+ ],
+ "title": "UnsubscribeFromPageRequest",
+ "additionalProperties": false,
+ "description": "UnsubscribeFromPageRequest is the request to unsubscribe from a status page."
+ },
+ "openstatus.status_page.v1.UnsubscribeFromPageResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the unsubscription was successful."
+ }
+ },
+ "title": "UnsubscribeFromPageResponse",
+ "additionalProperties": false,
+ "description": "UnsubscribeFromPageResponse is the response after unsubscribing from a status page."
+ },
+ "openstatus.status_page.v1.UpdateComponentGroupRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the component group to update (required)."
+ },
+ "name": {
+ "type": ["string", "null"],
+ "title": "name",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "New display name for the group (optional)."
+ },
+ "defaultOpen": {
+ "type": ["boolean", "null"],
+ "title": "default_open",
+ "description": "Whether the group should be expanded by default on the status page (optional)."
+ }
+ },
+ "title": "UpdateComponentGroupRequest",
+ "additionalProperties": false,
+ "description": "UpdateComponentGroupRequest is the request to update a component group."
+ },
+ "openstatus.status_page.v1.UpdateComponentGroupResponse": {
+ "type": "object",
+ "properties": {
+ "group": {
+ "title": "group",
+ "description": "The updated component group.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponentGroup"
+ }
+ },
+ "title": "UpdateComponentGroupResponse",
+ "additionalProperties": false,
+ "description": "UpdateComponentGroupResponse is the response after updating a component group."
+ },
+ "openstatus.status_page.v1.UpdateComponentRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the component to update (required)."
+ },
+ "name": {
+ "type": ["string", "null"],
+ "title": "name",
+ "maxLength": 256,
+ "description": "New display name for the component (optional)."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "New description for the component (optional)."
+ },
+ "order": {
+ "type": ["integer", "null"],
+ "title": "order",
+ "format": "int32",
+ "description": "New display order (optional)."
+ },
+ "groupId": {
+ "type": ["string", "null"],
+ "title": "group_id",
+ "description": "New group ID (optional, set to empty string to remove from group)."
+ },
+ "groupOrder": {
+ "type": ["integer", "null"],
+ "title": "group_order",
+ "format": "int32",
+ "description": "New order within the group (optional)."
+ }
+ },
+ "title": "UpdateComponentRequest",
+ "additionalProperties": false,
+ "description": "UpdateComponentRequest is the request to update a component."
+ },
+ "openstatus.status_page.v1.UpdateComponentResponse": {
+ "type": "object",
+ "properties": {
+ "component": {
+ "title": "component",
+ "description": "The updated component.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageComponent"
+ }
+ },
+ "title": "UpdateComponentResponse",
+ "additionalProperties": false,
+ "description": "UpdateComponentResponse is the response after updating a component."
+ },
+ "openstatus.status_page.v1.UpdateStatusPageRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the status page to update (required)."
+ },
+ "title": {
+ "type": ["string", "null"],
+ "title": "title",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "New title for the status page (optional)."
+ },
+ "description": {
+ "type": ["string", "null"],
+ "title": "description",
+ "maxLength": 1024,
+ "description": "New description for the status page (optional)."
+ },
+ "slug": {
+ "type": ["string", "null"],
+ "title": "slug",
+ "maxLength": 256,
+ "minLength": 1,
+ "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
+ "description": "New slug for the status page (optional)."
+ },
+ "homepageUrl": {
+ "type": ["string", "null"],
+ "title": "homepage_url",
+ "description": "New homepage URL (optional)."
+ },
+ "contactUrl": {
+ "type": ["string", "null"],
+ "title": "contact_url",
+ "description": "New contact URL (optional)."
+ },
+ "defaultLocale": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.Locale"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "default_locale",
+ "description": "New default locale for the status page (optional)."
+ },
+ "locales": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.Locale"
+ },
+ "title": "locales",
+ "description": "New enabled locales for the status page (optional)."
+ },
+ "icon": {
+ "type": ["string", "null"],
+ "title": "icon",
+ "maxLength": 1024,
+ "description": "New icon URL for the status page (optional)."
+ },
+ "customDomain": {
+ "type": ["string", "null"],
+ "title": "custom_domain",
+ "maxLength": 256,
+ "description": "New custom domain (optional)."
+ },
+ "theme": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageTheme"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "theme",
+ "description": "New visual theme (optional)."
+ },
+ "accessType": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.PageAccessType"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "access_type",
+ "description": "New access type (optional)."
+ },
+ "password": {
+ "type": ["string", "null"],
+ "title": "password",
+ "maxLength": 256,
+ "minLength": 1,
+ "description": "New password (optional, required when access_type is PASSWORD_PROTECTED)."
+ },
+ "authEmailDomains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "auth_email_domains",
+ "description": "New email domains (optional, required when access_type is AUTHENTICATED)."
+ },
+ "allowIndex": {
+ "type": ["boolean", "null"],
+ "title": "allow_index",
+ "description": "Whether search engines are allowed to index this status page (optional)."
+ },
+ "allowedIpRanges": {
+ "type": ["string", "null"],
+ "title": "allowed_ip_ranges",
+ "description": "Comma-separated IPv4 CIDR ranges (required when access_type is IP_RESTRICTED)."
+ },
+ "customTheme": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CustomTheme"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "custom_theme",
+ "description": "New per-mode CSS variable overrides (optional). Omit to keep the current\n value; send an empty message to clear. Requires the custom-theme plan feature."
+ }
+ },
+ "title": "UpdateStatusPageRequest",
+ "additionalProperties": false,
+ "description": "UpdateStatusPageRequest is the request to update a status page."
+ },
+ "openstatus.status_page.v1.UpdateStatusPageResponse": {
+ "type": "object",
+ "properties": {
+ "statusPage": {
+ "title": "status_page",
+ "description": "The updated status page.",
+ "$ref": "#/components/schemas/openstatus.status_page.v1.StatusPage"
+ }
+ },
+ "title": "UpdateStatusPageResponse",
+ "additionalProperties": false,
+ "description": "UpdateStatusPageResponse is the response after updating a status page."
+ },
+ "openstatus.status_page.v1.WebhookChannel": {
+ "type": "object",
+ "properties": {
+ "webhookUrl": {
+ "type": "string",
+ "title": "webhook_url",
+ "maxLength": 2048,
+ "minLength": 1,
+ "format": "uri",
+ "description": "Webhook URL (required). Payload flavor (Slack / Discord / generic) is auto-detected from the URL prefix."
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.WebhookChannelHeader"
+ },
+ "title": "headers",
+ "description": "Optional custom HTTP headers attached to every dispatch."
+ }
+ },
+ "title": "WebhookChannel",
+ "additionalProperties": false,
+ "description": "WebhookChannel carries the webhook-channel fields for CreatePageSubscription."
+ },
+ "openstatus.status_page.v1.WebhookChannelHeader": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "title": "key",
+ "minLength": 1
+ },
+ "value": {
+ "type": "string",
+ "title": "value"
+ }
+ },
+ "title": "WebhookChannelHeader",
+ "additionalProperties": false,
+ "description": "WebhookChannelHeader is a single custom HTTP header."
+ },
+ "openstatus.status_report.v1.AddStatusReportUpdateRequest": {
+ "type": "object",
+ "properties": {
+ "statusReportId": {
+ "type": "string",
+ "title": "status_report_id",
+ "minLength": 1,
+ "description": "ID of the status report to update (required)."
+ },
+ "status": {
+ "title": "status",
+ "description": "New status for the report (required).",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReportStatus"
+ },
+ "message": {
+ "type": "string",
+ "title": "message",
+ "minLength": 1,
+ "description": "Message describing what changed (required)."
+ },
+ "date": {
+ "type": ["string", "null"],
+ "title": "date",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
+ "description": "Optional date for the update (RFC 3339 format). Defaults to current time if not provided."
+ },
+ "notify": {
+ "type": ["boolean", "null"],
+ "title": "notify",
+ "description": "Whether to notify subscribers about this update (optional, defaults to false)."
+ },
+ "componentImpacts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.ComponentImpact"
+ },
+ "title": "component_impacts",
+ "description": "Per-component impacts this update sets (optional). Components named here\n are added to the report's affected set; omitted components keep their\n prior impact."
+ }
+ },
+ "title": "AddStatusReportUpdateRequest",
+ "additionalProperties": false,
+ "description": "AddStatusReportUpdateRequest is the request to add a new update to a status report."
+ },
+ "openstatus.status_report.v1.AddStatusReportUpdateResponse": {
+ "type": "object",
+ "properties": {
+ "statusReport": {
+ "title": "status_report",
+ "description": "The updated status report with the new update included.",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReport"
+ }
+ },
+ "title": "AddStatusReportUpdateResponse",
+ "additionalProperties": false,
+ "description": "AddStatusReportUpdateResponse is the response after adding an update to a status report."
+ },
+ "openstatus.status_report.v1.ComponentImpact": {
+ "type": "object",
+ "properties": {
+ "pageComponentId": {
+ "type": "string",
+ "title": "page_component_id",
+ "description": "ID of the affected page component."
+ },
+ "impact": {
+ "title": "impact",
+ "description": "Impact set for the component.",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.PageComponentImpact"
+ }
+ },
+ "title": "ComponentImpact",
+ "additionalProperties": false,
+ "description": "ComponentImpact pairs a page component with the impact an update set for it."
+ },
+ "openstatus.status_report.v1.CreateStatusReportRequest": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "examples": ["API Degradation Investigation"],
+ "title": "title",
+ "minLength": 1,
+ "description": "Title of the status report (required)."
+ },
+ "status": {
+ "title": "status",
+ "description": "Initial status (required).",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReportStatus"
+ },
+ "message": {
+ "type": "string",
+ "examples": [
+ "We are investigating reports of increased API latency."
+ ],
+ "title": "message",
+ "minLength": 1,
+ "description": "Initial message describing the incident (required)."
+ },
+ "date": {
+ "type": "string",
+ "examples": ["2024-03-15T10:30:00Z"],
+ "title": "date",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
+ "description": "Date when the event occurred (RFC 3339 format, required)."
+ },
+ "pageId": {
+ "type": "string",
+ "title": "page_id",
+ "minLength": 1,
+ "description": "Page ID to associate with this report (required)."
+ },
+ "pageComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "page_component_ids",
+ "description": "Page component IDs to associate with this report (optional)."
+ },
+ "notify": {
+ "type": ["boolean", "null"],
+ "title": "notify",
+ "description": "Whether to notify subscribers about this status report (optional, defaults to false)."
+ },
+ "componentImpacts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.ComponentImpact"
+ },
+ "title": "component_impacts",
+ "description": "Per-component impacts set by the initial update (optional). When provided,\n the named components are added to the report's affected set. Omitting this\n field creates a legacy report without impact tracking."
+ }
+ },
+ "title": "CreateStatusReportRequest",
+ "additionalProperties": false,
+ "description": "CreateStatusReportRequest is the request to create a new status report."
+ },
+ "openstatus.status_report.v1.CreateStatusReportResponse": {
+ "type": "object",
+ "properties": {
+ "statusReport": {
+ "title": "status_report",
+ "description": "The created status report.",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReport"
+ }
+ },
+ "title": "CreateStatusReportResponse",
+ "additionalProperties": false,
+ "description": "CreateStatusReportResponse is the response after creating a status report."
+ },
+ "openstatus.status_report.v1.DeleteStatusReportRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the status report to delete (required)."
+ }
+ },
+ "title": "DeleteStatusReportRequest",
+ "additionalProperties": false,
+ "description": "DeleteStatusReportRequest is the request to delete a status report."
+ },
+ "openstatus.status_report.v1.DeleteStatusReportResponse": {
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "title": "success",
+ "description": "Whether the deletion was successful."
+ }
+ },
+ "title": "DeleteStatusReportResponse",
+ "additionalProperties": false,
+ "description": "DeleteStatusReportResponse is the response after deleting a status report."
+ },
+ "openstatus.status_report.v1.GetStatusReportRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the status report to retrieve (required)."
+ }
+ },
+ "title": "GetStatusReportRequest",
+ "additionalProperties": false,
+ "description": "GetStatusReportRequest is the request to get a status report by ID."
+ },
+ "openstatus.status_report.v1.GetStatusReportResponse": {
+ "type": "object",
+ "properties": {
+ "statusReport": {
+ "title": "status_report",
+ "description": "The requested status report.",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReport"
+ }
+ },
+ "title": "GetStatusReportResponse",
+ "additionalProperties": false,
+ "description": "GetStatusReportResponse is the response containing the status report with its full update timeline."
+ },
+ "openstatus.status_report.v1.ListStatusReportsRequest": {
+ "type": "object",
+ "properties": {
+ "limit": {
+ "type": ["integer", "null"],
+ "title": "limit",
+ "maximum": 100,
+ "minimum": 1,
+ "format": "int32",
+ "description": "Maximum number of reports to return (1-100, defaults to 50)."
+ },
+ "offset": {
+ "type": ["integer", "null"],
+ "title": "offset",
+ "minimum": 0,
+ "format": "int32",
+ "description": "Number of reports to skip for pagination (defaults to 0)."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReportStatus"
+ },
+ "title": "statuses",
+ "description": "Filter by status (optional). If empty, returns all statuses."
+ }
+ },
+ "title": "ListStatusReportsRequest",
+ "additionalProperties": false,
+ "description": "ListStatusReportsRequest is the request to list status reports."
+ },
+ "openstatus.status_report.v1.ListStatusReportsResponse": {
+ "type": "object",
+ "properties": {
+ "statusReports": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReportSummary"
+ },
+ "title": "status_reports",
+ "description": "List of status reports (metadata only, use GetStatusReport for full details)."
+ },
+ "totalSize": {
+ "type": "integer",
+ "title": "total_size",
+ "format": "int32",
+ "description": "Total number of reports matching the filter."
+ }
+ },
+ "title": "ListStatusReportsResponse",
+ "additionalProperties": false,
+ "description": "ListStatusReportsResponse is the response containing status report summaries."
+ },
+ "openstatus.status_report.v1.PageComponentImpact": {
+ "type": "string",
+ "title": "PageComponentImpact",
+ "enum": [
+ "PAGE_COMPONENT_IMPACT_UNSPECIFIED",
+ "PAGE_COMPONENT_IMPACT_OPERATIONAL",
+ "PAGE_COMPONENT_IMPACT_DEGRADED_PERFORMANCE",
+ "PAGE_COMPONENT_IMPACT_PARTIAL_OUTAGE",
+ "PAGE_COMPONENT_IMPACT_MAJOR_OUTAGE"
+ ],
+ "description": "PageComponentImpact is the per-component impact a status report update sets.\n UNSPECIFIED means the caller doesn't speak impact (legacy) — it is NOT operational."
+ },
+ "openstatus.status_report.v1.StatusReport": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the status report."
+ },
+ "status": {
+ "title": "status",
+ "description": "Current status of the report.",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReportStatus"
+ },
+ "title": {
+ "type": "string",
+ "title": "title",
+ "description": "Title of the status report."
+ },
+ "pageComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "page_component_ids",
+ "description": "IDs of affected page components."
+ },
+ "updates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReportUpdate"
+ },
+ "title": "updates",
+ "description": "Timeline of updates for this report (only included in GetStatusReport)."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the report was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the report was last updated (RFC 3339 format)."
+ }
+ },
+ "title": "StatusReport",
+ "additionalProperties": false,
+ "description": "StatusReport represents an incident or maintenance report with full details."
+ },
+ "openstatus.status_report.v1.StatusReportStatus": {
+ "type": "string",
+ "title": "StatusReportStatus",
+ "enum": [
+ "STATUS_REPORT_STATUS_UNSPECIFIED",
+ "STATUS_REPORT_STATUS_INVESTIGATING",
+ "STATUS_REPORT_STATUS_IDENTIFIED",
+ "STATUS_REPORT_STATUS_MONITORING",
+ "STATUS_REPORT_STATUS_RESOLVED"
+ ],
+ "description": "StatusReportStatus represents the current state of a status report."
+ },
+ "openstatus.status_report.v1.StatusReportSummary": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the status report."
+ },
+ "status": {
+ "title": "status",
+ "description": "Current status of the report.",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReportStatus"
+ },
+ "title": {
+ "type": "string",
+ "title": "title",
+ "description": "Title of the status report."
+ },
+ "pageComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "page_component_ids",
+ "description": "IDs of affected page components."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the report was created (RFC 3339 format)."
+ },
+ "updatedAt": {
+ "type": "string",
+ "title": "updated_at",
+ "description": "Timestamp when the report was last updated (RFC 3339 format)."
+ }
+ },
+ "title": "StatusReportSummary",
+ "additionalProperties": false,
+ "description": "StatusReportSummary represents metadata for a status report (used in list responses)."
+ },
+ "openstatus.status_report.v1.StatusReportUpdate": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "description": "Unique identifier for the update."
+ },
+ "status": {
+ "title": "status",
+ "description": "Status at the time of this update.",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReportStatus"
+ },
+ "date": {
+ "type": "string",
+ "title": "date",
+ "description": "Timestamp when this update occurred (RFC 3339 format)."
+ },
+ "message": {
+ "type": "string",
+ "title": "message",
+ "description": "Message describing the update."
+ },
+ "createdAt": {
+ "type": "string",
+ "title": "created_at",
+ "description": "Timestamp when the update was created (RFC 3339 format)."
+ },
+ "componentImpacts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.ComponentImpact"
+ },
+ "title": "component_impacts",
+ "description": "Per-component impacts this update set (empty for legacy reports)."
+ }
+ },
+ "title": "StatusReportUpdate",
+ "additionalProperties": false,
+ "description": "StatusReportUpdate represents a single update entry in a status report timeline."
+ },
+ "openstatus.status_report.v1.UpdateStatusReportRequest": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "id",
+ "minLength": 1,
+ "description": "ID of the status report to update (required)."
+ },
+ "title": {
+ "type": ["string", "null"],
+ "title": "title",
+ "description": "New title for the report (optional)."
+ },
+ "pageComponentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "page_component_ids",
+ "description": "New list of page component IDs (optional, replaces existing list)."
+ },
+ "updatePageComponentIds": {
+ "type": ["boolean", "null"],
+ "title": "update_page_component_ids",
+ "description": "Set to true to update page component associations.\n When true, page_component_ids replaces the existing list (empty clears all).\n When false or unset, page_component_ids is ignored and existing associations are preserved."
+ }
+ },
+ "title": "UpdateStatusReportRequest",
+ "additionalProperties": false,
+ "description": "UpdateStatusReportRequest is the request to update a status report's metadata."
+ },
+ "openstatus.status_report.v1.UpdateStatusReportResponse": {
+ "type": "object",
+ "properties": {
+ "statusReport": {
+ "title": "status_report",
+ "description": "The updated status report.",
+ "$ref": "#/components/schemas/openstatus.status_report.v1.StatusReport"
+ }
+ },
+ "title": "UpdateStatusReportResponse",
+ "additionalProperties": false,
+ "description": "UpdateStatusReportResponse is the response after updating a status report."
+ }
+ }
+ },
+ "security": [
+ {
+ "ApiKeyAuth": []
+ }
+ ],
+ "tags": [
+ {
+ "name": "MonitorService",
+ "description": "Create, update, delete, and query monitors. Supports HTTP, TCP, and DNS monitor types\nwith configurable check intervals, regions, assertions, and alerting thresholds.\n"
+ },
+ {
+ "name": "StatusPageService",
+ "description": "Manage public status pages with components, component groups, and email subscribers.\nIncludes endpoints for retrieving full page content and aggregated status.\n"
+ },
+ {
+ "name": "NotificationService",
+ "description": "Configure notification channels (Slack, Discord, PagerDuty, email, webhooks, etc.)\nand associate them with monitors. Supports 12 notification providers.\n"
+ },
+ {
+ "name": "StatusReportService",
+ "description": "Create and manage incident reports with status updates. Reports follow a lifecycle:\ninvestigating -> identified -> monitoring -> resolved.\n"
+ },
+ {
+ "name": "MaintenanceService",
+ "description": "Schedule maintenance windows for status page components. Subscribers can be\nnotified automatically when maintenance is created.\n"
+ },
+ {
+ "name": "HealthService",
+ "description": "Health check endpoint for load balancer probes. No authentication required."
+ },
+ {
+ "name": "PrivateLocationService",
+ "description": "PrivateLocationService provides CRUD operations for private locations —\n self-hosted checker agents that run monitors from your own network."
+ }
+ ],
+ "paths": {
+ "/rpc/openstatus.health.v1.HealthService/Check": {
+ "get": {
+ "tags": ["HealthService"],
+ "summary": "Check",
+ "description": "Check returns the current serving status of the service.",
+ "operationId": "HealthService_Check.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.health.v1.CheckRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.health.v1.CheckResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["HealthService"],
+ "summary": "Check",
+ "description": "Check returns the current serving status of the service.",
+ "operationId": "HealthService_Check",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.health.v1.CheckRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.health.v1.CheckResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.maintenance.v1.MaintenanceService/CreateMaintenance": {
+ "post": {
+ "tags": ["MaintenanceService"],
+ "summary": "CreateMaintenance",
+ "description": "CreateMaintenance creates a new maintenance window.",
+ "operationId": "MaintenanceService_CreateMaintenance",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.CreateMaintenanceResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.maintenance.v1.MaintenanceService/DeleteMaintenance": {
+ "post": {
+ "tags": ["MaintenanceService"],
+ "summary": "DeleteMaintenance",
+ "description": "DeleteMaintenance removes a maintenance window.",
+ "operationId": "MaintenanceService_DeleteMaintenance",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.DeleteMaintenanceResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.maintenance.v1.MaintenanceService/GetMaintenance": {
+ "get": {
+ "tags": ["MaintenanceService"],
+ "summary": "GetMaintenance",
+ "description": "GetMaintenance retrieves a specific maintenance window by ID.",
+ "operationId": "MaintenanceService_GetMaintenance.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["MaintenanceService"],
+ "summary": "GetMaintenance",
+ "description": "GetMaintenance retrieves a specific maintenance window by ID.",
+ "operationId": "MaintenanceService_GetMaintenance",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.GetMaintenanceRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.GetMaintenanceResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.maintenance.v1.MaintenanceService/ListMaintenances": {
+ "get": {
+ "tags": ["MaintenanceService"],
+ "summary": "ListMaintenances",
+ "description": "ListMaintenances returns all maintenance windows for the workspace.",
+ "operationId": "MaintenanceService_ListMaintenances.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["MaintenanceService"],
+ "summary": "ListMaintenances",
+ "description": "ListMaintenances returns all maintenance windows for the workspace.",
+ "operationId": "MaintenanceService_ListMaintenances",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.ListMaintenancesRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.ListMaintenancesResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.maintenance.v1.MaintenanceService/UpdateMaintenance": {
+ "post": {
+ "tags": ["MaintenanceService"],
+ "summary": "UpdateMaintenance",
+ "description": "UpdateMaintenance updates a maintenance window.",
+ "operationId": "MaintenanceService_UpdateMaintenance",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.maintenance.v1.UpdateMaintenanceResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/CreateDNSMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "CreateDNSMonitor",
+ "description": "CreateDNSMonitor creates a new DNS monitor.",
+ "operationId": "MonitorService_CreateDNSMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateDNSMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/CreateGRPCMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "CreateGRPCMonitor",
+ "description": "CreateGRPCMonitor creates a new gRPC health check monitor.",
+ "operationId": "MonitorService_CreateGRPCMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateGRPCMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/CreateHTTPMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "CreateHTTPMonitor",
+ "description": "Creates a new HTTP monitor in the authenticated workspace. Configure the target URL, HTTP method, request headers and body, response assertions (status code, body content, headers), check periodicity, geographic regions, and optional OpenTelemetry export. The monitor starts checking immediately if set to active.",
+ "operationId": "MonitorService_CreateHTTPMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateHTTPMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/CreateICMPMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "CreateICMPMonitor",
+ "description": "CreateICMPMonitor creates a new ICMP monitor.",
+ "operationId": "MonitorService_CreateICMPMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateICMPMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/CreateTCPMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "CreateTCPMonitor",
+ "description": "CreateTCPMonitor creates a new TCP monitor.",
+ "operationId": "MonitorService_CreateTCPMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.CreateTCPMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/DeleteMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "DeleteMonitor",
+ "description": "DeleteMonitor removes a monitor.",
+ "operationId": "MonitorService_DeleteMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.DeleteMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.DeleteMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/GetMonitor": {
+ "get": {
+ "tags": ["MonitorService"],
+ "summary": "GetMonitor",
+ "description": "GetMonitor returns a single monitor by ID within the authenticated workspace.\n Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.",
+ "operationId": "MonitorService_GetMonitor.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "GetMonitor",
+ "description": "GetMonitor returns a single monitor by ID within the authenticated workspace.\n Returns the monitor configuration (HTTP, TCP, DNS, ICMP, or gRPC) using the MonitorConfig oneof type.",
+ "operationId": "MonitorService_GetMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/GetMonitorHTTPResponseLog": {
+ "get": {
+ "tags": ["MonitorService"],
+ "summary": "GetMonitorHTTPResponseLog",
+ "description": "GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.",
+ "operationId": "MonitorService_GetMonitorHTTPResponseLog.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "GetMonitorHTTPResponseLog",
+ "description": "GetMonitorHTTPResponseLog returns one response log for an HTTP monitor.",
+ "operationId": "MonitorService_GetMonitorHTTPResponseLog",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorHTTPResponseLogResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/GetMonitorStatus": {
+ "get": {
+ "tags": ["MonitorService"],
+ "summary": "GetMonitorStatus",
+ "description": "GetMonitorStatus returns the current status of all regions for a monitor.",
+ "operationId": "MonitorService_GetMonitorStatus.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "GetMonitorStatus",
+ "description": "GetMonitorStatus returns the current status of all regions for a monitor.",
+ "operationId": "MonitorService_GetMonitorStatus",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorStatusRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorStatusResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/GetMonitorSummary": {
+ "get": {
+ "tags": ["MonitorService"],
+ "summary": "GetMonitorSummary",
+ "description": "Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.",
+ "operationId": "MonitorService_GetMonitorSummary.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "GetMonitorSummary",
+ "description": "Returns aggregated metrics for a monitor including latency percentiles (p50, p75, p90, p95, p99), request counts by status (successful, degraded, failed), and the timestamp of the last check. Metrics can be scoped to a time range (1 day, 7 days, or 14 days) and filtered by specific regions.",
+ "operationId": "MonitorService_GetMonitorSummary",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.GetMonitorSummaryResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/ListMonitorHTTPResponseLogs": {
+ "get": {
+ "tags": ["MonitorService"],
+ "summary": "ListMonitorHTTPResponseLogs",
+ "description": "ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.",
+ "operationId": "MonitorService_ListMonitorHTTPResponseLogs.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "ListMonitorHTTPResponseLogs",
+ "description": "ListMonitorHTTPResponseLogs returns paginated response logs for an HTTP monitor from the 14-day HTTP response-log window.",
+ "operationId": "MonitorService_ListMonitorHTTPResponseLogs",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ListMonitorHTTPResponseLogsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/ListMonitors": {
+ "get": {
+ "tags": ["MonitorService"],
+ "summary": "ListMonitors",
+ "description": "ListMonitors returns a paginated list of all monitors in the workspace.",
+ "operationId": "MonitorService_ListMonitors.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "ListMonitors",
+ "description": "ListMonitors returns a paginated list of all monitors in the workspace.",
+ "operationId": "MonitorService_ListMonitors",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ListMonitorsRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.ListMonitorsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/TriggerMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "TriggerMonitor",
+ "description": "Manually triggers an immediate check for the specified monitor across all configured regions. This operation is rate-limited under the synthetic-checks quota. A monitor run record is created and the check is dispatched to the checker service.",
+ "operationId": "MonitorService_TriggerMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TriggerMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.TriggerMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/UpdateDNSMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "UpdateDNSMonitor",
+ "description": "UpdateDNSMonitor updates an existing DNS monitor.",
+ "operationId": "MonitorService_UpdateDNSMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateDNSMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/UpdateGRPCMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "UpdateGRPCMonitor",
+ "description": "UpdateGRPCMonitor updates an existing gRPC monitor.",
+ "operationId": "MonitorService_UpdateGRPCMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateGRPCMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/UpdateHTTPMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "UpdateHTTPMonitor",
+ "description": "UpdateHTTPMonitor updates an existing HTTP monitor.",
+ "operationId": "MonitorService_UpdateHTTPMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateHTTPMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/UpdateICMPMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "UpdateICMPMonitor",
+ "description": "UpdateICMPMonitor updates an existing ICMP monitor.",
+ "operationId": "MonitorService_UpdateICMPMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateICMPMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.monitor.v1.MonitorService/UpdateTCPMonitor": {
+ "post": {
+ "tags": ["MonitorService"],
+ "summary": "UpdateTCPMonitor",
+ "description": "UpdateTCPMonitor updates an existing TCP monitor.",
+ "operationId": "MonitorService_UpdateTCPMonitor",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.monitor.v1.UpdateTCPMonitorResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.notification.v1.NotificationService/CheckNotificationLimit": {
+ "get": {
+ "tags": ["NotificationService"],
+ "summary": "CheckNotificationLimit",
+ "description": "CheckNotificationLimit checks if the workspace has reached its notification limit.",
+ "operationId": "NotificationService_CheckNotificationLimit.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["NotificationService"],
+ "summary": "CheckNotificationLimit",
+ "description": "CheckNotificationLimit checks if the workspace has reached its notification limit.",
+ "operationId": "NotificationService_CheckNotificationLimit",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.CheckNotificationLimitRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.CheckNotificationLimitResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.notification.v1.NotificationService/CreateNotification": {
+ "post": {
+ "tags": ["NotificationService"],
+ "summary": "CreateNotification",
+ "description": "CreateNotification creates a new notification channel.",
+ "operationId": "NotificationService_CreateNotification",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.CreateNotificationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.CreateNotificationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.notification.v1.NotificationService/DeleteNotification": {
+ "post": {
+ "tags": ["NotificationService"],
+ "summary": "DeleteNotification",
+ "description": "DeleteNotification removes a notification channel.",
+ "operationId": "NotificationService_DeleteNotification",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.DeleteNotificationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.DeleteNotificationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.notification.v1.NotificationService/GetNotification": {
+ "get": {
+ "tags": ["NotificationService"],
+ "summary": "GetNotification",
+ "description": "GetNotification retrieves a notification channel by ID.",
+ "operationId": "NotificationService_GetNotification.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.GetNotificationRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.GetNotificationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["NotificationService"],
+ "summary": "GetNotification",
+ "description": "GetNotification retrieves a notification channel by ID.",
+ "operationId": "NotificationService_GetNotification",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.GetNotificationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.GetNotificationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.notification.v1.NotificationService/ListNotifications": {
+ "get": {
+ "tags": ["NotificationService"],
+ "summary": "ListNotifications",
+ "description": "ListNotifications returns a list of notification channels.",
+ "operationId": "NotificationService_ListNotifications.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.ListNotificationsRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.ListNotificationsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["NotificationService"],
+ "summary": "ListNotifications",
+ "description": "ListNotifications returns a list of notification channels.",
+ "operationId": "NotificationService_ListNotifications",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.ListNotificationsRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.ListNotificationsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.notification.v1.NotificationService/SendTestNotification": {
+ "post": {
+ "tags": ["NotificationService"],
+ "summary": "SendTestNotification",
+ "description": "Sends a test notification to the specified provider to verify that the configuration is correct. This does not require an existing notification channel - just provide the provider type and its configuration data. Returns success status and an error message if the test failed.",
+ "operationId": "NotificationService_SendTestNotification",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.SendTestNotificationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.SendTestNotificationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.notification.v1.NotificationService/UpdateNotification": {
+ "post": {
+ "tags": ["NotificationService"],
+ "summary": "UpdateNotification",
+ "description": "UpdateNotification updates an existing notification channel.",
+ "operationId": "NotificationService_UpdateNotification",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.UpdateNotificationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.notification.v1.UpdateNotificationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.private_location.v1.PrivateLocationService/CreatePrivateLocation": {
+ "post": {
+ "tags": ["PrivateLocationService"],
+ "summary": "CreatePrivateLocation",
+ "description": "Creates a private location. The agent token is generated by the server and returned in the response - it cannot be supplied by the caller. Use the token to configure the agent so it can pull its monitors and report results.",
+ "operationId": "PrivateLocationService_CreatePrivateLocation",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.CreatePrivateLocationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.private_location.v1.PrivateLocationService/DeletePrivateLocation": {
+ "post": {
+ "tags": ["PrivateLocationService"],
+ "summary": "DeletePrivateLocation",
+ "description": "DeletePrivateLocation removes a private location.",
+ "operationId": "PrivateLocationService_DeletePrivateLocation",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.DeletePrivateLocationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.private_location.v1.PrivateLocationService/GetPrivateLocation": {
+ "get": {
+ "tags": ["PrivateLocationService"],
+ "summary": "GetPrivateLocation",
+ "description": "GetPrivateLocation retrieves a single private location by ID, including\n its agent token.",
+ "operationId": "PrivateLocationService_GetPrivateLocation.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["PrivateLocationService"],
+ "summary": "GetPrivateLocation",
+ "description": "GetPrivateLocation retrieves a single private location by ID, including\n its agent token.",
+ "operationId": "PrivateLocationService_GetPrivateLocation",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.GetPrivateLocationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.GetPrivateLocationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.private_location.v1.PrivateLocationService/ListPrivateLocations": {
+ "get": {
+ "tags": ["PrivateLocationService"],
+ "summary": "ListPrivateLocations",
+ "description": "ListPrivateLocations returns a paginated list of private location\n summaries. Agent tokens are not included - use GetPrivateLocation.",
+ "operationId": "PrivateLocationService_ListPrivateLocations.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["PrivateLocationService"],
+ "summary": "ListPrivateLocations",
+ "description": "ListPrivateLocations returns a paginated list of private location\n summaries. Agent tokens are not included - use GetPrivateLocation.",
+ "operationId": "PrivateLocationService_ListPrivateLocations",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.ListPrivateLocationsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.private_location.v1.PrivateLocationService/UpdatePrivateLocation": {
+ "post": {
+ "tags": ["PrivateLocationService"],
+ "summary": "UpdatePrivateLocation",
+ "description": "UpdatePrivateLocation updates a private location.",
+ "operationId": "PrivateLocationService_UpdatePrivateLocation",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.private_location.v1.UpdatePrivateLocationResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/AddMonitorComponent": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "AddMonitorComponent",
+ "description": "AddMonitorComponent adds a monitor-based component to a status page.",
+ "operationId": "StatusPageService_AddMonitorComponent",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.AddMonitorComponentRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.AddMonitorComponentResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/AddStaticComponent": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "AddStaticComponent",
+ "description": "AddStaticComponent adds a static component to a status page.",
+ "operationId": "StatusPageService_AddStaticComponent",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.AddStaticComponentRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.AddStaticComponentResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/CreateComponentGroup": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "CreateComponentGroup",
+ "description": "CreateComponentGroup creates a new component group.",
+ "operationId": "StatusPageService_CreateComponentGroup",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CreateComponentGroupRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CreateComponentGroupResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/CreatePageSubscription": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "CreatePageSubscription: operator-added subscriber (email or webhook), no verification.",
+ "description": "Operator-added subscriber (email or webhook) with no verification flow — the partner starts receiving notifications immediately. Supports Slack and Discord webhook URLs in addition to email. A management token is still generated so the subscriber can self-manage (update scope, unsubscribe) without operator involvement. Use this for vendor/partner integrations where consent is established out-of-band; use SubscribeToPage for subscriber-initiated signups that require double opt-in.",
+ "operationId": "StatusPageService_CreatePageSubscription",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CreatePageSubscriptionResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/CreateStatusPage": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "CreateStatusPage",
+ "description": "CreateStatusPage creates a new status page.",
+ "operationId": "StatusPageService_CreateStatusPage",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CreateStatusPageRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.CreateStatusPageResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/DeleteComponentGroup": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "DeleteComponentGroup",
+ "description": "DeleteComponentGroup removes a component group.",
+ "operationId": "StatusPageService_DeleteComponentGroup",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.DeleteComponentGroupResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/DeleteStatusPage": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "DeleteStatusPage",
+ "description": "DeleteStatusPage removes a status page.",
+ "operationId": "StatusPageService_DeleteStatusPage",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.DeleteStatusPageRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.DeleteStatusPageResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/GetOverallStatus": {
+ "get": {
+ "tags": ["StatusPageService"],
+ "summary": "GetOverallStatus",
+ "description": "Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.",
+ "operationId": "StatusPageService_GetOverallStatus.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "GetOverallStatus",
+ "description": "Returns the overall status of a status page along with individual component statuses. The overall status is computed from active status reports and maintenances with the following priority: degraded (from active status reports) > maintenance (from active maintenance windows) > operational.",
+ "operationId": "StatusPageService_GetOverallStatus",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetOverallStatusRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetOverallStatusResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/GetPageComponent": {
+ "get": {
+ "tags": ["StatusPageService"],
+ "summary": "GetPageComponent",
+ "description": "Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.",
+ "operationId": "StatusPageService_GetPageComponent.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "GetPageComponent",
+ "description": "Returns a single status-page component by its ID, scoped to the authenticated workspace. Use this to resolve a component id to its name (and other fields) instead of fetching the whole page via GetStatusPageContent and filtering .components.",
+ "operationId": "StatusPageService_GetPageComponent",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetPageComponentRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetPageComponentResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/GetPageComponentDailySummary": {
+ "get": {
+ "tags": ["StatusPageService"],
+ "summary": "GetPageComponentDailySummary",
+ "description": "Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).",
+ "operationId": "StatusPageService_GetPageComponentDailySummary.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "GetPageComponentDailySummary",
+ "description": "Returns per-component daily status buckets (ok/degraded/error/count plus a resolved status) merged with the incident, maintenance, and status-report timeline over the last N days (max 45). Suitable as a single source of truth for status-bar and uptime-calendar rendering. Supports two access paths: by id (authenticated, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).",
+ "operationId": "StatusPageService_GetPageComponentDailySummary",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetPageComponentDailySummaryResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/GetStatusPage": {
+ "get": {
+ "tags": ["StatusPageService"],
+ "summary": "GetStatusPage",
+ "description": "GetStatusPage retrieves a specific status page by ID.",
+ "operationId": "StatusPageService_GetStatusPage.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "GetStatusPage",
+ "description": "GetStatusPage retrieves a specific status page by ID.",
+ "operationId": "StatusPageService_GetStatusPage",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageContent": {
+ "get": {
+ "tags": ["StatusPageService"],
+ "summary": "GetStatusPageContent",
+ "description": "Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).",
+ "operationId": "StatusPageService_GetStatusPageContent.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "GetStatusPageContent",
+ "description": "Returns the full content of a status page including its components, component groups, active status reports, and scheduled maintenances. Supports two access paths: by ID (requires authentication, workspace-scoped) or by slug (public access, requires the page to be published with access_type=PUBLIC).",
+ "operationId": "StatusPageService_GetStatusPageContent",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageContentRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageContentResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/GetStatusPageOverview": {
+ "get": {
+ "tags": ["StatusPageService"],
+ "summary": "GetStatusPageOverview",
+ "description": "Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.",
+ "operationId": "StatusPageService_GetStatusPageOverview.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "GetStatusPageOverview",
+ "description": "Returns everything about a single status page in one authenticated call: the page, its rich rendering configuration, components, component groups, active/recent status reports, maintenances, and the computed overall + per-component statuses. Workspace-scoped by id; there is no public slug access path. Does not include uptime time-series — use GetPageComponentDailySummary for that.",
+ "operationId": "StatusPageService_GetStatusPageOverview",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.GetStatusPageOverviewResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/ListStatusPages": {
+ "get": {
+ "tags": ["StatusPageService"],
+ "summary": "ListStatusPages",
+ "description": "ListStatusPages returns all status pages for the workspace.",
+ "operationId": "StatusPageService_ListStatusPages.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "ListStatusPages",
+ "description": "ListStatusPages returns all status pages for the workspace.",
+ "operationId": "StatusPageService_ListStatusPages",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ListStatusPagesRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ListStatusPagesResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/ListSubscribers": {
+ "get": {
+ "tags": ["StatusPageService"],
+ "summary": "ListSubscribers",
+ "description": "ListSubscribers returns all subscribers for a status page.",
+ "operationId": "StatusPageService_ListSubscribers.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "ListSubscribers",
+ "description": "ListSubscribers returns all subscribers for a status page.",
+ "operationId": "StatusPageService_ListSubscribers",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ListSubscribersRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.ListSubscribersResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/RemoveComponent": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "RemoveComponent",
+ "description": "RemoveComponent removes a component from a status page.",
+ "operationId": "StatusPageService_RemoveComponent",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.RemoveComponentRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.RemoveComponentResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/SubscribeToPage": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "SubscribeToPage: end-user email self-signup with double opt-in verification.",
+ "description": "End-user email self-signup with double opt-in verification. A verification email is sent and the subscription activates only after the recipient confirms. If the email was previously unsubscribed, the existing row is reactivated instead of a duplicate being created. Use this for subscriber-initiated signups on the public status page; use CreatePageSubscription for operator-initiated (vendor) subscriptions that should skip verification.",
+ "operationId": "StatusPageService_SubscribeToPage",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.SubscribeToPageRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.SubscribeToPageResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/UnsubscribeFromPage": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "UnsubscribeFromPage",
+ "description": "UnsubscribeFromPage removes a subscription from a status page.",
+ "operationId": "StatusPageService_UnsubscribeFromPage",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.UnsubscribeFromPageResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/UpdateComponent": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "UpdateComponent",
+ "description": "UpdateComponent updates an existing component.",
+ "operationId": "StatusPageService_UpdateComponent",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.UpdateComponentRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.UpdateComponentResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/UpdateComponentGroup": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "UpdateComponentGroup",
+ "description": "UpdateComponentGroup updates an existing component group.",
+ "operationId": "StatusPageService_UpdateComponentGroup",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.UpdateComponentGroupResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_page.v1.StatusPageService/UpdateStatusPage": {
+ "post": {
+ "tags": ["StatusPageService"],
+ "summary": "UpdateStatusPage",
+ "description": "UpdateStatusPage updates an existing status page.",
+ "operationId": "StatusPageService_UpdateStatusPage",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.UpdateStatusPageRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_page.v1.UpdateStatusPageResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_report.v1.StatusReportService/AddStatusReportUpdate": {
+ "post": {
+ "tags": ["StatusReportService"],
+ "summary": "AddStatusReportUpdate",
+ "description": "Adds a new update entry to an existing status report and transitions the report to the specified status. Status reports follow a lifecycle: investigating -> identified -> monitoring -> resolved. If notify is true, subscribers of the associated page are notified by email about the update.",
+ "operationId": "StatusReportService_AddStatusReportUpdate",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.AddStatusReportUpdateResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_report.v1.StatusReportService/CreateStatusReport": {
+ "post": {
+ "tags": ["StatusReportService"],
+ "summary": "CreateStatusReport",
+ "description": "Creates a new status report with an initial update entry. The report is associated with a status page and optionally specific page components. An initial StatusReportUpdate is created automatically with the provided status, message, and date. If notify is true, subscribers of the associated page are notified by email.",
+ "operationId": "StatusReportService_CreateStatusReport",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.CreateStatusReportRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.CreateStatusReportResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_report.v1.StatusReportService/DeleteStatusReport": {
+ "post": {
+ "tags": ["StatusReportService"],
+ "summary": "DeleteStatusReport",
+ "description": "DeleteStatusReport removes a status report and all its updates.",
+ "operationId": "StatusReportService_DeleteStatusReport",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.DeleteStatusReportRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.DeleteStatusReportResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_report.v1.StatusReportService/GetStatusReport": {
+ "get": {
+ "tags": ["StatusReportService"],
+ "summary": "GetStatusReport",
+ "description": "GetStatusReport retrieves a specific status report by ID (includes full update timeline).",
+ "operationId": "StatusReportService_GetStatusReport.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusReportService"],
+ "summary": "GetStatusReport",
+ "description": "GetStatusReport retrieves a specific status report by ID (includes full update timeline).",
+ "operationId": "StatusReportService_GetStatusReport",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.GetStatusReportRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.GetStatusReportResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_report.v1.StatusReportService/ListStatusReports": {
+ "get": {
+ "tags": ["StatusReportService"],
+ "summary": "ListStatusReports",
+ "description": "ListStatusReports returns all status reports for the workspace (metadata only).",
+ "operationId": "StatusReportService_ListStatusReports.get",
+ "parameters": [
+ {
+ "name": "message",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest"
+ }
+ }
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["StatusReportService"],
+ "summary": "ListStatusReports",
+ "description": "ListStatusReports returns all status reports for the workspace (metadata only).",
+ "operationId": "StatusReportService_ListStatusReports",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.ListStatusReportsRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.ListStatusReportsResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/rpc/openstatus.status_report.v1.StatusReportService/UpdateStatusReport": {
+ "post": {
+ "tags": ["StatusReportService"],
+ "summary": "UpdateStatusReport",
+ "description": "UpdateStatusReport updates the metadata of a status report (title, page components).",
+ "operationId": "StatusReportService_UpdateStatusReport",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.UpdateStatusReportRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/openstatus.status_report.v1.UpdateStatusReportResponse"
+ }
+ }
+ }
+ },
+ "default": {
+ "description": "Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connect.error"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/apps/server/static/openapi.yaml b/apps/server/static/openapi.yaml
index ed2d5f69a..5a0999bb7 100644
--- a/apps/server/static/openapi.yaml
+++ b/apps/server/static/openapi.yaml
@@ -6,6 +6,9 @@ info:
contact:
url: https://www.openstatus.dev
+servers:
+ - url: https://api.openstatus.dev
+ description: Production
externalDocs:
description: OpenStatus Documentation
url: https://www.openstatus.dev/docs
diff --git a/apps/web/deno.jsonc b/apps/web/deno.jsonc
index d3de83dde..5ae72d87e 100644
--- a/apps/web/deno.jsonc
+++ b/apps/web/deno.jsonc
@@ -1,5 +1,9 @@
-/* Needed to fix the import aliases */
+/* Needed to fix the import aliases, and to render components in `deno test` */
{
+ "compilerOptions": {
+ "jsx": "react-jsx",
+ "jsxImportSource": "react",
+ },
"imports": {
"@/": "./src/",
},
diff --git a/apps/web/next.config.ts b/apps/web/next.config.ts
index f3911b2a1..d672da00f 100644
--- a/apps/web/next.config.ts
+++ b/apps/web/next.config.ts
@@ -35,7 +35,7 @@ const homepageLinkHeader = [
'</.well-known/agent-skills/index.json>; rel="agent-skills"; type="application/json"',
'</.well-known/mcp.json>; rel="mcp-server"; type="application/json"',
'<https://www.openstatus.dev/docs>; rel="service-doc"; type="text/html"',
- '<https://api.openstatus.dev/openapi>; rel="service-desc"; type="application/json"',
+ '<https://www.openstatus.dev/openapi.json>; rel="service-desc"; type="application/json"',
'<https://www.openstatus.dev/llms.txt>; rel="describedby"; type="text/plain"',
'<https://www.openstatus.dev/llms-full.txt>; rel="alternate"; type="text/plain"; title="llms-full"',
'<https://www.openstatus.dev/terms>; rel="terms-of-service"',
@@ -230,6 +230,22 @@ const nextConfig: NextConfig = {
async rewrites() {
return {
beforeFiles: [
+ // `/openapi.json` is the path agents probe for an API description, and
+ // they probe it on the site they were pointed at. The spec is generated
+ // in apps/server, so proxy rather than keep a second copy in sync.
+ // Host-scoped and ahead of the status-page rules below: those catch
+ // every path on any host once `sp_mode=new` is set, and a customer's
+ // custom domain has no business serving the openstatus API spec.
+ {
+ source: "/openapi.json",
+ has: [{ type: "host", value: "(www\\.)?openstatus\\.dev" }],
+ destination: "https://api.openstatus.dev/openapi.json",
+ },
+ {
+ source: "/openapi.yaml",
+ has: [{ type: "host", value: "(www\\.)?openstatus\\.dev" }],
+ destination: "https://api.openstatus.dev/openapi.yaml",
+ },
{
source: "/status-page/themes/:path*",
destination: "https://www.stpg.dev/:path*",
diff --git a/apps/web/src/app/(ai)/mcp/route.test.ts b/apps/web/src/app/(ai)/mcp/route.test.ts
new file mode 100644
index 000000000..38f323524
--- /dev/null
+++ b/apps/web/src/app/(ai)/mcp/route.test.ts
@@ -0,0 +1,48 @@
+import { expect } from "@std/expect";
+import { describe, test } from "@std/testing/bdd";
+
+import { GET, MCP_TRANSPORT_URL, POST } from "./route";
+
+describe("/mcp discovery", () => {
+ test("serves the server card to JSON clients", async () => {
+ const res = GET(
+ new Request("https://www.openstatus.dev/mcp", {
+ headers: { accept: "application/json" },
+ }),
+ );
+ expect(res.status).toBe(200);
+ const card = await res.json();
+ expect(card.transport.url).toBe(MCP_TRANSPORT_URL);
+ expect(card.capabilities.resources).toBeDefined();
+ expect(card.resources.length).toBeGreaterThan(0);
+ });
+
+ test("sends browsers to the human-readable page", () => {
+ const res = GET(
+ new Request("https://www.openstatus.dev/mcp", {
+ headers: { accept: "text/html" },
+ }),
+ );
+ expect(res.status).toBe(302);
+ expect(res.headers.get("location")).toBe(
+ "https://www.openstatus.dev/tooling/mcp-server",
+ );
+ });
+
+ test("forwards a streamable GET to the transport", () => {
+ const res = GET(
+ new Request("https://www.openstatus.dev/mcp", {
+ headers: { accept: "text/event-stream" },
+ }),
+ );
+ expect(res.status).toBe(307);
+ expect(res.headers.get("location")).toBe(MCP_TRANSPORT_URL);
+ });
+
+ // 307 rather than 302 is what keeps the method and body intact.
+ test("forwards a JSON-RPC POST to the transport with a 307", () => {
+ const res = POST();
+ expect(res.status).toBe(307);
+ expect(res.headers.get("location")).toBe(MCP_TRANSPORT_URL);
+ });
+});
diff --git a/apps/web/src/app/(ai)/mcp/route.ts b/apps/web/src/app/(ai)/mcp/route.ts
index 26cd28830..eeacc16dd 100644
--- a/apps/web/src/app/(ai)/mcp/route.ts
+++ b/apps/web/src/app/(ai)/mcp/route.ts
@@ -2,10 +2,33 @@
// (no domain coupling); browsers get redirected to the human-readable page.
import { GET as serverCardGET } from "../../.well-known/mcp/server-card.json/route";
+/** Where the streamable-HTTP transport actually lives. */
+export const MCP_TRANSPORT_URL = "https://api.openstatus.dev/mcp";
+
export function GET(request: Request) {
const accept = request.headers.get("accept") ?? "";
+ // A client keeps the URL it was handed after the 307 below, so its Streamable
+ // HTTP listening channel arrives here too. Forwarding it lets the transport
+ // answer (405 in stateless mode) instead of handing an SSE request the
+ // human-readable page.
+ if (accept.includes("text/event-stream")) {
+ return Response.redirect(MCP_TRANSPORT_URL, 307);
+ }
if (accept.includes("application/json")) {
return serverCardGET();
}
return Response.redirect(new URL("/tooling/mcp-server", request.url), 302);
}
+
+/**
+ * MCP clients POST their JSON-RPC handshake at whatever URL they were handed,
+ * and this one is only a discovery document. 307 keeps the method and body so
+ * the client reaches the transport instead of reading a 405 as a dead server.
+ */
+export function POST() {
+ return Response.redirect(MCP_TRANSPORT_URL, 307);
+}
+
+export function DELETE() {
+ return Response.redirect(MCP_TRANSPORT_URL, 307);
+}
diff --git a/apps/web/src/app/.well-known/api-catalog/route.ts b/apps/web/src/app/.well-known/api-catalog/route.ts
index 6b141bf0b..dd5847202 100644
--- a/apps/web/src/app/.well-known/api-catalog/route.ts
+++ b/apps/web/src/app/.well-known/api-catalog/route.ts
@@ -6,7 +6,7 @@ const linkset = {
anchor: "https://api.openstatus.dev",
"service-desc": [
{
- href: "https://api.openstatus.dev/openapi",
+ href: "https://api.openstatus.dev/openapi.json",
type: "application/json",
title: "Openstatus API — OpenAPI description",
},
diff --git a/apps/web/src/app/.well-known/mcp/server-card.json/route.ts b/apps/web/src/app/.well-known/mcp/server-card.json/route.ts
index 02a1b7431..fe03f6c13 100644
--- a/apps/web/src/app/.well-known/mcp/server-card.json/route.ts
+++ b/apps/web/src/app/.well-known/mcp/server-card.json/route.ts
@@ -27,10 +27,11 @@ const card = {
in: "header",
name: "x-openstatus-key",
description:
- "Workspace API key. Generate one in Settings → API Tokens. Same credential used by the CLI, REST API, and Terraform provider.",
+ "Workspace API key. Generate one in Settings → API Tokens. Same credential used by the CLI, REST API, and Terraform provider. Required for tools; the resources below are readable without one.",
},
capabilities: {
tools: { listChanged: false },
+ resources: { listChanged: true },
},
tools: [
{
@@ -70,9 +71,31 @@ const card = {
description: "Adjust a scheduled maintenance window.",
},
],
+ resources: [
+ {
+ name: "openapi-specification",
+ uri: "https://api.openstatus.dev/openapi.json",
+ mimeType: "application/json",
+ description: "Machine-readable description of the openstatus HTTP API.",
+ },
+ {
+ name: "mcp-server-reference",
+ uri: "https://www.openstatus.dev/docs/reference/mcp-server",
+ mimeType: "text/markdown",
+ description:
+ "Transport, authentication, and the full tool list for this server.",
+ },
+ {
+ name: "site-index",
+ uri: "https://www.openstatus.dev/llms.txt",
+ mimeType: "text/plain",
+ description:
+ "llms.txt: product context, pricing, and an index of every page.",
+ },
+ ],
links: {
"service-doc": "https://www.openstatus.dev/docs/reference/mcp-server/",
- "service-desc": "https://api.openstatus.dev/openapi",
+ "service-desc": "https://api.openstatus.dev/openapi.json",
"terms-of-service": "https://www.openstatus.dev/terms",
"privacy-policy": "https://www.openstatus.dev/privacy",
},
diff --git a/apps/web/src/app/api/markdown/[[...path]]/route.ts b/apps/web/src/app/api/markdown/[[...path]]/route.ts
index b7c456a3a..a9cd98867 100644
--- a/apps/web/src/app/api/markdown/[[...path]]/route.ts
+++ b/apps/web/src/app/api/markdown/[[...path]]/route.ts
@@ -1,5 +1,6 @@
import { type NextRequest, NextResponse } from "next/server";
+import { notFoundMarkdown } from "../../../../content/agent-recovery";
import { convertMdxToMarkdown } from "../../../../content/convert";
import {
generateStatusDetailMarkdown,
@@ -9,6 +10,17 @@ import { resolveContent } from "../../../../content/utils/resolve";
export const runtime = "nodejs"; // Need fs access for content loading
+/**
+ * `next.config.ts` rewrites any path here when the request asks for
+ * `text/markdown`, so these bodies are one of two representations of the same
+ * URL. Without `Vary: Accept` a CDN can hand the cached markdown to a browser
+ * asking for HTML, or the reverse.
+ */
+const MARKDOWN_HEADERS = {
+ "Content-Type": "text/markdown; charset=utf-8",
+ Vary: "Accept, Accept-Encoding",
+};
+
/**
* GET handler for markdown content negotiation
* Serves clean markdown when Accept: text/markdown header is present
@@ -27,7 +39,7 @@ export async function GET(
return new NextResponse(statusMd, {
status: 200,
headers: {
- "Content-Type": "text/markdown; charset=utf-8",
+ ...MARKDOWN_HEADERS,
"Cache-Control":
"public, max-age=60, s-maxage=60, stale-while-revalidate=300",
"X-Content-Source": "status",
@@ -39,7 +51,17 @@ export async function GET(
const result = resolveContent(pathname);
if (!result) {
- return new NextResponse("Not Found", { status: 404 });
+ // A dead link is where an agent most needs a way back, so the 404 body
+ // is markdown pointing at the sitemap, llms.txt and the API description
+ // rather than a bare status line.
+ return new NextResponse(notFoundMarkdown(pathname), {
+ status: 404,
+ headers: {
+ ...MARKDOWN_HEADERS,
+ "Cache-Control": "public, max-age=60, s-maxage=60",
+ "X-Content-Source": "not-found",
+ },
+ });
}
let markdown: string;
@@ -60,7 +82,7 @@ export async function GET(
return new NextResponse(markdown, {
status: 200,
headers: {
- "Content-Type": "text/markdown; charset=utf-8",
+ ...MARKDOWN_HEADERS,
"Cache-Control":
"public, max-age=3600, s-maxage=86400, stale-while-revalidate=86400",
"X-Content-Source": contentSource,
diff --git a/apps/web/src/content/agent-recovery.test.ts b/apps/web/src/content/agent-recovery.test.ts
new file mode 100644
index 000000000..603132800
--- /dev/null
+++ b/apps/web/src/content/agent-recovery.test.ts
@@ -0,0 +1,25 @@
+import { expect } from "@std/expect";
+import { describe, test } from "@std/testing/bdd";
+
+import { AGENT_RECOVERY_LINKS, notFoundMarkdown } from "./agent-recovery";
+
+describe("notFoundMarkdown", () => {
+ test("is markdown that names the requested path", () => {
+ const body = notFoundMarkdown("/does-not-exist");
+ expect(body.startsWith("# 404")).toBe(true);
+ expect(body).toContain("`/does-not-exist`");
+ });
+
+ test("neutralises a path that would break out of the code span", () => {
+ const body = notFoundMarkdown("/a`b\n# Injected heading");
+ expect(body).not.toContain("# Injected heading");
+ expect(body).toContain("`/a%60b%0A#%20Injected%20heading`");
+ });
+
+ test("links every recovery entry absolutely", () => {
+ const body = notFoundMarkdown("/x");
+ for (const [, href] of AGENT_RECOVERY_LINKS) {
+ expect(body).toContain(`(https://www.openstatus.dev${href})`);
+ }
+ });
+});
diff --git a/apps/web/src/content/agent-recovery.ts b/apps/web/src/content/agent-recovery.ts
new file mode 100644
index 000000000..647d0546d
--- /dev/null
+++ b/apps/web/src/content/agent-recovery.ts
@@ -0,0 +1,34 @@
+const BASE = "https://www.openstatus.dev";
+
+/** Machine-readable entry points an agent can retry against after a dead link. */
+export const AGENT_RECOVERY_LINKS = [
+ ["Sitemap", "/sitemap.xml"],
+ ["llms.txt", "/llms.txt"],
+ ["Documentation", "/docs"],
+ ["OpenAPI specification", "/openapi.json"],
+ ["MCP server card", "/.well-known/mcp.json"],
+] as const;
+
+/**
+ * Body for a path that does not exist. Markdown rather than an app shell, so a
+ * crawler that hits a dead link can find its way back instead of re-crawling.
+ */
+export function notFoundMarkdown(pathname: string): string {
+ const links = AGENT_RECOVERY_LINKS.map(
+ ([title, href]) => `- [${title}](${BASE}${href})`,
+ ).join("\n");
+ // The path is attacker-chosen and lands in a code span an agent reads:
+ // percent-encoding keeps a backtick or newline from closing it and injecting
+ // markdown of its own. `encodeURI` leaves `/` readable.
+ return `# 404 — Not Found
+
+No page exists at \`${encodeURI(pathname)}\` on openstatus.dev.
+
+## Where to look next
+
+${links}
+
+Every page is also available as markdown: append \`.md\` to the URL or send
+\`Accept: text/markdown\`.
+`;
+}
diff --git a/apps/web/src/content/convert.test.ts b/apps/web/src/content/convert.test.ts
new file mode 100644
index 000000000..67546b831
--- /dev/null
+++ b/apps/web/src/content/convert.test.ts
@@ -0,0 +1,27 @@
+import { expect } from "@std/expect";
+import { describe, test } from "@std/testing/bdd";
+
+import { convertMdxToMarkdown } from "./convert";
+import { getHomePage } from "./utils";
+
+describe("convertMdxToMarkdown", () => {
+ test("serializes Details regardless of the props that follow summary", () => {
+ const markdown = convertMdxToMarkdown({
+ metadata: { title: "t" },
+ content:
+ '<Details summary="Q?" headingLevel={3}>\n\nAnswer.\n\n</Details>',
+ slug: "t",
+ href: "/t",
+ } as Parameters<typeof convertMdxToMarkdown>[0]);
+ expect(markdown).toContain("<summary>Q?</summary>");
+ expect(markdown).toContain("Answer.");
+ });
+
+ test("the home page keeps every FAQ entry in its markdown representation", () => {
+ const home = getHomePage();
+ const markdown = convertMdxToMarkdown(home);
+ for (const entry of home.metadata.faq ?? []) {
+ expect(markdown).toContain(`<summary>${entry.question}</summary>`);
+ }
+ });
+});
diff --git a/apps/web/src/content/mdx-components/details.test.ts b/apps/web/src/content/mdx-components/details.test.ts
new file mode 100644
index 000000000..6db076937
--- /dev/null
+++ b/apps/web/src/content/mdx-components/details.test.ts
@@ -0,0 +1,40 @@
+import { expect } from "@std/expect";
+import { describe, test } from "@std/testing/bdd";
+import { renderToStaticMarkup } from "react-dom/server";
+
+import { Details } from "./details";
+
+const render = (props: Parameters<typeof Details>[0]) =>
+ renderToStaticMarkup(Details(props));
+
+describe("Details", () => {
+ test("renders a plain summary by default", () => {
+ expect(render({ summary: "What is openstatus?", children: "A" })).toBe(
+ '<details id="what-is-openstatus"><summary>What is openstatus?</summary>A</details>',
+ );
+ });
+
+ test("renders the summary as a heading when asked", () => {
+ const html = render({
+ summary: "What is openstatus?",
+ children: "A",
+ headingLevel: 3,
+ });
+ expect(html).toContain("<summary><h3>What is openstatus?</h3></summary>");
+ });
+
+ test("keeps the anchor id stable across both forms", () => {
+ const plain = render({
+ summary: "Do you offer annual billing?",
+ children: "A",
+ });
+ const heading = render({
+ summary: "Do you offer annual billing?",
+ children: "A",
+ headingLevel: 3,
+ });
+ const id = 'id="do-you-offer-annual-billing"';
+ expect(plain).toContain(id);
+ expect(heading).toContain(id);
+ });
+});
diff --git a/apps/web/src/content/mdx-components/details.tsx b/apps/web/src/content/mdx-components/details.tsx
index cdbed171b..7c018c34d 100644
--- a/apps/web/src/content/mdx-components/details.tsx
+++ b/apps/web/src/content/mdx-components/details.tsx
@@ -1,17 +1,30 @@
+import { createElement } from "react";
+
import { slugify } from "./heading";
export function Details({
children,
summary,
open = false,
+ headingLevel,
}: {
children: React.ReactNode;
summary: string;
open?: boolean;
+ /**
+ * Renders the summary as a real heading. Set it where the block is a section
+ * of the page outline — an FAQ entry under an `h2` — so crawlers see the
+ * nesting. Styling is neutralised in `globals.css`; the look is unchanged.
+ */
+ headingLevel?: 2 | 3 | 4;
}) {
return (
<details id={slugify(summary)} open={open}>
- <summary>{summary}</summary>
+ <summary>
+ {headingLevel
+ ? createElement(`h${headingLevel}`, null, summary)
+ : summary}
+ </summary>
{children}
</details>
);
diff --git a/apps/web/src/content/pages/home.mdx b/apps/web/src/content/pages/home.mdx
index 1aedb34a3..27be3bf5b 100644
--- a/apps/web/src/content/pages/home.mdx
+++ b/apps/web/src/content/pages/home.mdx
@@ -103,7 +103,7 @@ Check any URL's response time from every one of our 28 regions. No account, no c
## Frequently asked questions
-<Details summary="What is openstatus?">
+<Details summary="What is openstatus?" headingLevel={3}>
Openstatus gives you a branded status page and uptime monitoring that's audit-ready out of the box. Set up status.yourcompany.com, connect your monitors, and start communicating incidents in minutes.
@@ -111,7 +111,7 @@ It's open-source, self-hostable, and used by teams like [Cal.com](https://status
</Details>
-<Details summary="Do I need a status page for SOC 2?">
+<Details summary="Do I need a status page for SOC 2?" headingLevel={3}>
SOC 2's CC2.3 criteria requires you to demonstrate incident communication with external parties, but it doesn't prescribe a specific tool. That said, a status page is the **fastest, most auditor-friendly** way to satisfy that requirement.
@@ -121,7 +121,7 @@ Read more about [SOC 2 status pages](/use-case/compliance).
</Details>
-<Details summary="How does openstatus help with SOC 2 compliance?">
+<Details summary="How does openstatus help with SOC 2 compliance?" headingLevel={3}>
Openstatus gives you everything an auditor needs to verify your incident communication process:
@@ -135,7 +135,7 @@ You can be SOC 2-ready in minutes, not weeks.
</Details>
-<Details summary="What does the free plan include?">
+<Details summary="What does the free plan include?" headingLevel={3}>
The free plan includes **one monitor**, **one status page** (with three page components), and a minimum check interval of `10m`. Check the pricing table for a full comparison.
@@ -143,7 +143,7 @@ No credit card required. Upgrade or cancel at any time.
</Details>
-<Details summary="Who is behind openstatus?">
+<Details summary="Who is behind openstatus?" headingLevel={3}>
Openstatus is built by [Thibault](https://bsky.app/profile/thibaultleouay.dev) and [Max](https://x.com/mxkaske), a bootstrapped two-person team building in public.
@@ -159,7 +159,7 @@ Read more on [our about page](/about).
</Details>
-<Details summary="What regions does openstatus monitor from?">
+<Details summary="What regions does openstatus monitor from?" headingLevel={3}>
Openstatus monitors from **28 regions worldwide** across all continents:
@@ -191,7 +191,7 @@ Sydney 🇦🇺
</Details>
-<Details summary="Do you offer annual billing?">
+<Details summary="Do you offer annual billing?" headingLevel={3}>
Yes. All paid plans are available with **monthly** or **annual** billing. Choose annual billing to get **2 months free**: that's Starter at $300/year ($25/mo) and Pro at $1,000/year (~$83/mo).
@@ -199,7 +199,7 @@ You can switch between billing cycles at any time. Check the [pricing page](/pri
</Details>
-<Details summary="Can I self-host openstatus?">
+<Details summary="Can I self-host openstatus?" headingLevel={3}>
Yes. Openstatus is fully open source and can be self-hosted using its **8.5MB Docker image**. You can also deploy **private monitoring locations** behind your firewall to check internal services not exposed to the internet.
@@ -210,7 +210,7 @@ The source code is available on [GitHub](https://openstatus.dev/github).
</Details>
-<Details summary="Does openstatus have an API?">
+<Details summary="Does openstatus have an API?" headingLevel={3}>
Yes. Openstatus exposes a typed **JSON-over-HTTP API** powered by [ConnectRPC](/blog/migrating-from-zod-openapi-to-connectrpc), with a published [OpenAPI spec](https://api.openstatus.dev/openapi).
@@ -218,7 +218,7 @@ Every action in the dashboard (managing monitors, status pages, status reports,
</Details>
-<Details summary="Can I manage openstatus from Claude or ChatGPT?">
+<Details summary="Can I manage openstatus from Claude or ChatGPT?" headingLevel={3}>
Yes. Openstatus ships a remote [MCP server](/tooling/mcp-server) at `api.openstatus.dev/mcp` that connects **Claude Desktop**, **ChatGPT**, **Cursor**, and any [Model Context Protocol](https://modelcontextprotocol.io) client to your workspace.
@@ -226,7 +226,7 @@ The assistant can list status pages, create and resolve status reports, and sche
</Details>
-<Details summary="Can I manage monitors as code?">
+<Details summary="Can I manage monitors as code?" headingLevel={3}>
Yes. Openstatus offers two ways to treat monitoring as code:
diff --git a/apps/web/src/content/pages/unrelated/contact.mdx b/apps/web/src/content/pages/unrelated/contact.mdx
new file mode 100644
index 000000000..33bc2c7ed
--- /dev/null
+++ b/apps/web/src/content/pages/unrelated/contact.mdx
@@ -0,0 +1,72 @@
+---
+title: "Contact"
+publishedAt: "2026-08-22"
+author: "openstatus"
+description: "How to reach openstatus — support email, Discord, GitHub, a call with the founders, security disclosures, and our postal address."
+category: "company"
+faq:
+ - question: "How do I contact openstatus support?"
+ answer: "Email [email protected], join the openstatus Discord, or open an issue on GitHub. Every plan includes email support, and there is no ticket queue in between — the two founders answer."
+ - question: "How fast does openstatus respond to support requests?"
+ answer: "We answer email within one business day. Discord is usually faster during European working hours. For an ongoing incident on your own infrastructure, say so in the subject line and we prioritise it."
+ - question: "How do I report a security vulnerability in openstatus?"
+ answer: "Email [email protected], the contact published in https://www.openstatus.dev/.well-known/security.txt, and follow the disclosure policy at https://github.com/openstatusHQ/openstatus/security/policy. Please do not open a public GitHub issue for an unpatched vulnerability."
+---
+
+Openstatus is built by a two-person team, so whoever answers you also wrote the
+code. There is no ticket queue and no support tier — pick whichever channel
+fits the question.
+
+## Support
+
+- **Email** — [[email protected]](mailto:[email protected]). Best for
+ account, billing, and plan questions. We answer within one business day.
+- **Discord** — [join the community](https://www.openstatus.dev/discord) for
+ setup questions, monitor configuration, and quick answers from other users.
+- **GitHub** — [openstatushq/openstatus](https://github.com/openstatushq/openstatus/issues)
+ for bug reports and feature requests. Openstatus is open source, so the issue
+ you file is the issue we work from.
+- **Call** — [book 30 minutes](https://cal.com/team/openstatus/30min) with the
+ founders for onboarding, migrations from another status page, or an
+ architecture review before you roll out monitoring.
+
+## Sales and enterprise
+
+For volume pricing, invoicing, procurement paperwork, security questionnaires,
+or a self-hosted deployment, email
+[[email protected]](mailto:[email protected]) with the company name and what
+you need. Vendor forms, SOC 2 evidence requests, and DPAs go to the same
+address. See [pricing](/pricing) for the published plans and
+[subprocessors](/subprocessors) for the vendors we rely on.
+
+## Security
+
+Report vulnerabilities to
+[[email protected]](mailto:[email protected]) rather than in a public
+issue — that is the contact published in
+[/.well-known/security.txt](/.well-known/security.txt) (RFC 9116). The
+disclosure policy lives on
+[GitHub](https://github.com/openstatusHQ/openstatus/security/policy) and the
+rest of our posture is on the [security page](/security).
+
+## Press and partnerships
+
+Email [[email protected]](mailto:[email protected]) for logos, screenshots,
+quotes, or open-source partnership requests. Our story is on the
+[about page](/about).
+
+## Postal address
+
+OpenStatus SAS
+122 Rue Amelot
+75011 Paris
+France
+
+## For agents
+
+Machine-readable contact details are published as `Organization` JSON-LD on
+every page of this site, in
+[/.well-known/security.txt](/.well-known/security.txt), and in the
+[API catalog](/.well-known/api-catalog). The support email
+`[email protected]` is the correct destination for anything that needs a
+human.
diff --git a/apps/web/src/content/pages/unrelated/not-found.mdx b/apps/web/src/content/pages/unrelated/not-found.mdx
index 90873ba86..62aa65431 100644
--- a/apps/web/src/content/pages/unrelated/not-found.mdx
+++ b/apps/web/src/content/pages/unrelated/not-found.mdx
@@ -15,4 +15,14 @@ Are you looking for something specific?
- [Dashboard](https://app.openstatus.dev)
- [Global Speed Checker](/play/checker)
+For crawlers and agents:
+
+- [Sitemap](https://www.openstatus.dev/sitemap.xml)
+- [llms.txt](https://www.openstatus.dev/llms.txt)
+- [OpenAPI specification](https://www.openstatus.dev/openapi.json)
+- [MCP server card](https://www.openstatus.dev/.well-known/mcp.json)
+
+Every page is also available as markdown — append `.md` to the URL, or send an
+`Accept: text/markdown` header.
+
Or [Return Home](/)
diff --git a/apps/web/src/lib/metadata/structured-data.test.ts b/apps/web/src/lib/metadata/structured-data.test.ts
new file mode 100644
index 000000000..012a82d43
--- /dev/null
+++ b/apps/web/src/lib/metadata/structured-data.test.ts
@@ -0,0 +1,21 @@
+import { expect } from "@std/expect";
+import { describe, test } from "@std/testing/bdd";
+
+import { getJsonLDOrganization } from "./structured-data";
+
+describe("getJsonLDOrganization", () => {
+ test("publishes a postal address alongside the contact points", () => {
+ const org = getJsonLDOrganization();
+ // schema-dts types every node as `object | string`; narrow once.
+ if (typeof org === "string") throw new Error("expected an Organization");
+
+ expect(org.address).toEqual({
+ "@type": "PostalAddress",
+ streetAddress: "122 Rue Amelot",
+ postalCode: "75011",
+ addressLocality: "Paris",
+ addressCountry: "FR",
+ });
+ expect(Array.isArray(org.contactPoint)).toBe(true);
+ });
+});
diff --git a/apps/web/src/lib/metadata/structured-data.ts b/apps/web/src/lib/metadata/structured-data.ts
index e00d6d0d2..e5c957b6f 100644
--- a/apps/web/src/lib/metadata/structured-data.ts
+++ b/apps/web/src/lib/metadata/structured-data.ts
@@ -131,6 +131,15 @@ export const getJsonLDOrganization = (): WithContext<Organization> => {
"https://bsky.app/profile/openstatus.dev",
"https://x.com/openstatushq",
],
+ // Same address the contact page and every email footer already carry —
+ // it is what lets an assistant tie the entity to the registered company.
+ address: {
+ "@type": "PostalAddress",
+ streetAddress: "122 Rue Amelot",
+ postalCode: "75011",
+ addressLocality: "Paris",
+ addressCountry: "FR",
+ },
contactPoint: [
{
"@type": "ContactPoint",
diff --git a/apps/web/src/styles/globals.css b/apps/web/src/styles/globals.css
index eb5746e5b..f6fe02495 100644
--- a/apps/web/src/styles/globals.css
+++ b/apps/web/src/styles/globals.css
@@ -277,6 +277,17 @@
@apply cursor-pointer font-medium text-foreground select-none;
}
+/* A summary rendered as a heading (see Details `headingLevel`) is outline
+ semantics, not a visual step — inherit the summary's own type entirely so
+ the rendering is identical to a plain-text summary. */
+.prose details summary :is(h2, h3, h4) {
+ display: inline;
+ margin: 0;
+ font: inherit;
+ letter-spacing: inherit;
+ color: inherit;
+}
+
.prose details summary:hover {
@apply bg-muted;
}
diff --git a/packages/proto/api/openstatus/maintenance/v1/service.proto b/packages/proto/api/openstatus/maintenance/v1/service.proto
index f02058c84..ba6e40cfe 100644
--- a/packages/proto/api/openstatus/maintenance/v1/service.proto
+++ b/packages/proto/api/openstatus/maintenance/v1/service.proto
@@ -47,13 +47,13 @@ message CreateMaintenanceRequest {
// Start time of the maintenance window (RFC 3339 format, required).
string from = 3 [
(buf.validate.field).string.pattern = "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
- (gnostic.openapi.v3.property) = {example: {yaml: "2024-03-01T02:00:00Z"}}
+ (gnostic.openapi.v3.property) = {example: {yaml: "\"2024-03-01T02:00:00Z\""}}
];
// End time of the maintenance window (RFC 3339 format, required).
string to = 4 [
(buf.validate.field).string.pattern = "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
- (gnostic.openapi.v3.property) = {example: {yaml: "2024-03-01T06:00:00Z"}}
+ (gnostic.openapi.v3.property) = {example: {yaml: "\"2024-03-01T06:00:00Z\""}}
];
// Page ID to associate with this maintenance (required).
diff --git a/packages/proto/api/openstatus/status_page/v1/status_page.proto b/packages/proto/api/openstatus/status_page/v1/status_page.proto
index e7b0d80f8..5cc27647b 100644
--- a/packages/proto/api/openstatus/status_page/v1/status_page.proto
+++ b/packages/proto/api/openstatus/status_page/v1/status_page.proto
@@ -130,12 +130,12 @@ message StatusPage {
// Timestamp when the page was created (RFC 3339 format).
string created_at = 12 [
- (gnostic.openapi.v3.property) = {example: {yaml: "2024-01-15T09:00:00Z"}}
+ (gnostic.openapi.v3.property) = {example: {yaml: "\"2024-01-15T09:00:00Z\""}}
];
// Timestamp when the page was last updated (RFC 3339 format).
string updated_at = 13 [
- (gnostic.openapi.v3.property) = {example: {yaml: "2024-06-20T14:30:00Z"}}
+ (gnostic.openapi.v3.property) = {example: {yaml: "\"2024-06-20T14:30:00Z\""}}
];
// Default locale for the status page.
diff --git a/packages/proto/api/openstatus/status_report/v1/service.proto b/packages/proto/api/openstatus/status_report/v1/service.proto
index bd28f4224..de6a1c8ec 100644
--- a/packages/proto/api/openstatus/status_report/v1/service.proto
+++ b/packages/proto/api/openstatus/status_report/v1/service.proto
@@ -61,7 +61,7 @@ message CreateStatusReportRequest {
// Date when the event occurred (RFC 3339 format, required).
string date = 4 [
(buf.validate.field).string.pattern = "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,9})?(Z|[+-]\\d{2}:\\d{2})$",
- (gnostic.openapi.v3.property) = {example: {yaml: "2024-03-15T10:30:00Z"}}
+ (gnostic.openapi.v3.property) = {example: {yaml: "\"2024-03-15T10:30:00Z\""}}
];
// Page ID to associate with this report (required).
diff --git a/packages/proto/base.openapi.yaml b/packages/proto/base.openapi.yaml
index d868b6908..91bf48412 100644
--- a/packages/proto/base.openapi.yaml
+++ b/packages/proto/base.openapi.yaml
@@ -8,6 +8,9 @@ info:
contact:
url: https://www.openstatus.dev
+servers:
+ - url: https://api.openstatus.dev
+ description: Production
externalDocs:
description: OpenStatus Documentation
url: https://www.openstatus.dev/docs
diff --git a/packages/proto/gen/openapi.yaml b/packages/proto/gen/openapi.yaml
index ed2d5f69a..5a0999bb7 100644
--- a/packages/proto/gen/openapi.yaml
+++ b/packages/proto/gen/openapi.yaml
@@ -6,6 +6,9 @@ info:
contact:
url: https://www.openstatus.dev
+servers:
+ - url: https://api.openstatus.dev
+ description: Production
externalDocs:
description: OpenStatus Documentation
url: https://www.openstatus.dev/docs
diff --git a/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts b/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts
index f0d3f3db0..51f6d4a72 100644
--- a/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts
+++ b/packages/proto/gen/ts/openstatus/maintenance/v1/service_pb.ts
@@ -14,7 +14,7 @@ import type { Message } from "@bufbuild/protobuf";
* Describes the file openstatus/maintenance/v1/service.proto.
*/
export const file_openstatus_maintenance_v1_service: GenFile = /*@__PURE__*/
- fileDesc("CidvcGVuc3RhdHVzL21haW50ZW5hbmNlL3YxL3NlcnZpY2UucHJvdG8SGW9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEiqAMKGENyZWF0ZU1haW50ZW5hbmNlUmVxdWVzdBIyCgV0aXRsZRgBIAEoCUIjukcWOhQSEkRhdGFiYXNlIE1pZ3JhdGlvbrpIB3IFEAEYgAISGAoHbWVzc2FnZRgCIAEoCUIHukgEcgIQARJ0CgRmcm9tGAMgASgJQma6Rxg6FhIUMjAyNC0wMy0wMVQwMjowMDowMFq6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSQScgoCdG8YBCABKAlCZrpHGDoWEhQyMDI0LTAzLTAxVDA2OjAwOjAwWrpISHJGMkReXGR7NH0tXGR7Mn0tXGR7Mn1UXGR7Mn06XGR7Mn06XGR7Mn0oXC5cZHsxLDl9KT8oWnxbKy1dXGR7Mn06XGR7Mn0pJBIYCgdwYWdlX2lkGAUgASgJQge6SARyAhABEhoKEnBhZ2VfY29tcG9uZW50X2lkcxgGIAMoCRITCgZub3RpZnkYByABKAhIAIgBAUIJCgdfbm90aWZ5IlgKGUNyZWF0ZU1haW50ZW5hbmNlUmVzcG9uc2USOwoLbWFpbnRlbmFuY2UYASABKAsyJi5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLk1haW50ZW5hbmNlIiwKFUdldE1haW50ZW5hbmNlUmVxdWVzdBITCgJpZBgBIAEoCUIHukgEcgIQASJVChZHZXRNYWludGVuYW5jZVJlc3BvbnNlEjsKC21haW50ZW5hbmNlGAEgASgLMiYub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5NYWludGVuYW5jZSKNAQoXTGlzdE1haW50ZW5hbmNlc1JlcXVlc3QSHQoFbGltaXQYASABKAVCCbpIBhoEGGQoAUgAiAEBEhwKBm9mZnNldBgCIAEoBUIHukgEGgIoAEgBiAEBEhQKB3BhZ2VfaWQYAyABKAlIAogBAUIICgZfbGltaXRCCQoHX29mZnNldEIKCghfcGFnZV9pZCJzChhMaXN0TWFpbnRlbmFuY2VzUmVzcG9uc2USQwoMbWFpbnRlbmFuY2VzGAEgAygLMi0ub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5NYWludGVuYW5jZVN1bW1hcnkSEgoKdG90YWxfc2l6ZRgCIAEoBSLRAwoYVXBkYXRlTWFpbnRlbmFuY2VSZXF1ZXN0EhMKAmlkGAEgASgJQge6SARyAhABEh4KBXRpdGxlGAIgASgJQgq6SAdyBRABGIACSACIAQESFAoHbWVzc2FnZRgDIAEoCUgBiAEBEl4KBGZyb20YBCABKAlCS7pISHJGMkReXGR7NH0tXGR7Mn0tXGR7Mn1UXGR7Mn06XGR7Mn06XGR7Mn0oXC5cZHsxLDl9KT8oWnxbKy1dXGR7Mn06XGR7Mn0pJEgCiAEBElwKAnRvGAUgASgJQku6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSRIA4gBARIYCgdwYWdlX2lkGAYgASgJQgIYAUgEiAEBEhoKEnBhZ2VfY29tcG9uZW50X2lkcxgHIAMoCRImChl1cGRhdGVfcGFnZV9jb21wb25lbnRfaWRzGAggASgISAWIAQFCCAoGX3RpdGxlQgoKCF9tZXNzYWdlQgcKBV9mcm9tQgUKA190b0IKCghfcGFnZV9pZEIcChpfdXBkYXRlX3BhZ2VfY29tcG9uZW50X2lkcyJYChlVcGRhdGVNYWludGVuYW5jZVJlc3BvbnNlEjsKC21haW50ZW5hbmNlGAEgASgLMiYub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5NYWludGVuYW5jZSIvChhEZWxldGVNYWludGVuYW5jZVJlcXVlc3QSEwoCaWQYASABKAlCB7pIBHICEAEiLAoZRGVsZXRlTWFpbnRlbmFuY2VSZXNwb25zZRIPCgdzdWNjZXNzGAEgASgIMpMFChJNYWludGVuYW5jZVNlcnZpY2USfgoRQ3JlYXRlTWFpbnRlbmFuY2USMy5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkNyZWF0ZU1haW50ZW5hbmNlUmVxdWVzdBo0Lm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuQ3JlYXRlTWFpbnRlbmFuY2VSZXNwb25zZRJ6Cg5HZXRNYWludGVuYW5jZRIwLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuR2V0TWFpbnRlbmFuY2VSZXF1ZXN0GjEub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5HZXRNYWludGVuYW5jZVJlc3BvbnNlIgOQAgESgAEKEExpc3RNYWludGVuYW5jZXMSMi5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkxpc3RNYWludGVuYW5jZXNSZXF1ZXN0GjMub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5MaXN0TWFpbnRlbmFuY2VzUmVzcG9uc2UiA5ACARJ+ChFVcGRhdGVNYWludGVuYW5jZRIzLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuVXBkYXRlTWFpbnRlbmFuY2VSZXF1ZXN0GjQub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5VcGRhdGVNYWludGVuYW5jZVJlc3BvbnNlEn4KEURlbGV0ZU1haW50ZW5hbmNlEjMub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5EZWxldGVNYWludGVuYW5jZVJlcXVlc3QaNC5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkRlbGV0ZU1haW50ZW5hbmNlUmVzcG9uc2VCW1pZZ2l0aHViLmNvbS9vcGVuc3RhdHVzaHEvb3BlbnN0YXR1cy9wYWNrYWdlcy9wcm90by9vcGVuc3RhdHVzL21haW50ZW5hbmNlL3YxO21haW50ZW5hbmNldjFiBnByb3RvMw", [file_buf_validate_validate, file_gnostic_openapi_v3_annotations, file_openstatus_maintenance_v1_maintenance]);
+ fileDesc("CidvcGVuc3RhdHVzL21haW50ZW5hbmNlL3YxL3NlcnZpY2UucHJvdG8SGW9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEirAMKGENyZWF0ZU1haW50ZW5hbmNlUmVxdWVzdBIyCgV0aXRsZRgBIAEoCUIjukcWOhQSEkRhdGFiYXNlIE1pZ3JhdGlvbrpIB3IFEAEYgAISGAoHbWVzc2FnZRgCIAEoCUIHukgEcgIQARJ2CgRmcm9tGAMgASgJQmi6Rxo6GBIWIjIwMjQtMDMtMDFUMDI6MDA6MDBaIrpISHJGMkReXGR7NH0tXGR7Mn0tXGR7Mn1UXGR7Mn06XGR7Mn06XGR7Mn0oXC5cZHsxLDl9KT8oWnxbKy1dXGR7Mn06XGR7Mn0pJBJ0CgJ0bxgEIAEoCUJoukcaOhgSFiIyMDI0LTAzLTAxVDA2OjAwOjAwWiK6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSQSGAoHcGFnZV9pZBgFIAEoCUIHukgEcgIQARIaChJwYWdlX2NvbXBvbmVudF9pZHMYBiADKAkSEwoGbm90aWZ5GAcgASgISACIAQFCCQoHX25vdGlmeSJYChlDcmVhdGVNYWludGVuYW5jZVJlc3BvbnNlEjsKC21haW50ZW5hbmNlGAEgASgLMiYub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5NYWludGVuYW5jZSIsChVHZXRNYWludGVuYW5jZVJlcXVlc3QSEwoCaWQYASABKAlCB7pIBHICEAEiVQoWR2V0TWFpbnRlbmFuY2VSZXNwb25zZRI7CgttYWludGVuYW5jZRgBIAEoCzImLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2UijQEKF0xpc3RNYWludGVuYW5jZXNSZXF1ZXN0Eh0KBWxpbWl0GAEgASgFQgm6SAYaBBhkKAFIAIgBARIcCgZvZmZzZXQYAiABKAVCB7pIBBoCKABIAYgBARIUCgdwYWdlX2lkGAMgASgJSAKIAQFCCAoGX2xpbWl0QgkKB19vZmZzZXRCCgoIX3BhZ2VfaWQicwoYTGlzdE1haW50ZW5hbmNlc1Jlc3BvbnNlEkMKDG1haW50ZW5hbmNlcxgBIAMoCzItLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2VTdW1tYXJ5EhIKCnRvdGFsX3NpemUYAiABKAUi0QMKGFVwZGF0ZU1haW50ZW5hbmNlUmVxdWVzdBITCgJpZBgBIAEoCUIHukgEcgIQARIeCgV0aXRsZRgCIAEoCUIKukgHcgUQARiAAkgAiAEBEhQKB21lc3NhZ2UYAyABKAlIAYgBARJeCgRmcm9tGAQgASgJQku6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSRIAogBARJcCgJ0bxgFIAEoCUJLukhIckYyRF5cZHs0fS1cZHsyfS1cZHsyfVRcZHsyfTpcZHsyfTpcZHsyfShcLlxkezEsOX0pPyhafFsrLV1cZHsyfTpcZHsyfSkkSAOIAQESGAoHcGFnZV9pZBgGIAEoCUICGAFIBIgBARIaChJwYWdlX2NvbXBvbmVudF9pZHMYByADKAkSJgoZdXBkYXRlX3BhZ2VfY29tcG9uZW50X2lkcxgIIAEoCEgFiAEBQggKBl90aXRsZUIKCghfbWVzc2FnZUIHCgVfZnJvbUIFCgNfdG9CCgoIX3BhZ2VfaWRCHAoaX3VwZGF0ZV9wYWdlX2NvbXBvbmVudF9pZHMiWAoZVXBkYXRlTWFpbnRlbmFuY2VSZXNwb25zZRI7CgttYWludGVuYW5jZRgBIAEoCzImLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTWFpbnRlbmFuY2UiLwoYRGVsZXRlTWFpbnRlbmFuY2VSZXF1ZXN0EhMKAmlkGAEgASgJQge6SARyAhABIiwKGURlbGV0ZU1haW50ZW5hbmNlUmVzcG9uc2USDwoHc3VjY2VzcxgBIAEoCDKTBQoSTWFpbnRlbmFuY2VTZXJ2aWNlEn4KEUNyZWF0ZU1haW50ZW5hbmNlEjMub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5DcmVhdGVNYWludGVuYW5jZVJlcXVlc3QaNC5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkNyZWF0ZU1haW50ZW5hbmNlUmVzcG9uc2USegoOR2V0TWFpbnRlbmFuY2USMC5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLkdldE1haW50ZW5hbmNlUmVxdWVzdBoxLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuR2V0TWFpbnRlbmFuY2VSZXNwb25zZSIDkAIBEoABChBMaXN0TWFpbnRlbmFuY2VzEjIub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5MaXN0TWFpbnRlbmFuY2VzUmVxdWVzdBozLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuTGlzdE1haW50ZW5hbmNlc1Jlc3BvbnNlIgOQAgESfgoRVXBkYXRlTWFpbnRlbmFuY2USMy5vcGVuc3RhdHVzLm1haW50ZW5hbmNlLnYxLlVwZGF0ZU1haW50ZW5hbmNlUmVxdWVzdBo0Lm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuVXBkYXRlTWFpbnRlbmFuY2VSZXNwb25zZRJ+ChFEZWxldGVNYWludGVuYW5jZRIzLm9wZW5zdGF0dXMubWFpbnRlbmFuY2UudjEuRGVsZXRlTWFpbnRlbmFuY2VSZXF1ZXN0GjQub3BlbnN0YXR1cy5tYWludGVuYW5jZS52MS5EZWxldGVNYWludGVuYW5jZVJlc3BvbnNlQltaWWdpdGh1Yi5jb20vb3BlbnN0YXR1c2hxL29wZW5zdGF0dXMvcGFja2FnZXMvcHJvdG8vb3BlbnN0YXR1cy9tYWludGVuYW5jZS92MTttYWludGVuYW5jZXYxYgZwcm90bzM", [file_buf_validate_validate, file_gnostic_openapi_v3_annotations, file_openstatus_maintenance_v1_maintenance]);
/**
* CreateMaintenanceRequest is the request to create a new maintenance window.
diff --git a/packages/proto/gen/ts/openstatus/status_page/v1/status_page_pb.ts b/packages/proto/gen/ts/openstatus/status_page/v1/status_page_pb.ts
index fa0e7b264..a700bc44c 100644
--- a/packages/proto/gen/ts/openstatus/status_page/v1/status_page_pb.ts
+++ b/packages/proto/gen/ts/openstatus/status_page/v1/status_page_pb.ts
@@ -11,7 +11,7 @@ import type { Message } from "@bufbuild/protobuf";
* Describes the file openstatus/status_page/v1/status_page.proto.
*/
export const file_openstatus_status_page_v1_status_page: GenFile = /*@__PURE__*/
- fileDesc("CitvcGVuc3RhdHVzL3N0YXR1c19wYWdlL3YxL3N0YXR1c19wYWdlLnByb3RvEhlvcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxIuoBCgtDdXN0b21UaGVtZRJACgVsaWdodBgBIAMoCzIxLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuQ3VzdG9tVGhlbWUuTGlnaHRFbnRyeRI+CgRkYXJrGAIgAygLMjAub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5DdXN0b21UaGVtZS5EYXJrRW50cnkaLAoKTGlnaHRFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBGisKCURhcmtFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBIsMBChFQYWdlQ29uZmlndXJhdGlvbhI+CgttZXRyaWNfdHlwZRgBIAEoDjIpLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuUGFnZU1ldHJpY1R5cGUSOAoIYmFyX3R5cGUYAiABKA4yJi5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLlBhZ2VCYXJUeXBlEhMKC3Nob3dfdXB0aW1lGAMgASgIEhEKCXRoZW1lX2tleRgEIAEoCRIMCgRkYXlzGAUgASgFItIFCgpTdGF0dXNQYWdlEgoKAmlkGAEgASgJEg0KBXRpdGxlGAIgASgJEhMKC2Rlc2NyaXB0aW9uGAMgASgJEh4KBHNsdWcYBCABKAlCELpHDToLEglhY21lLWNvcnASMAoNY3VzdG9tX2RvbWFpbhgFIAEoCUIZukcWOhQSEnN0YXR1cy5leGFtcGxlLmNvbRIRCglwdWJsaXNoZWQYBiABKAgSPgoLYWNjZXNzX3R5cGUYByABKA4yKS5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLlBhZ2VBY2Nlc3NUeXBlEjMKBXRoZW1lGAggASgOMiQub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5QYWdlVGhlbWUSFAoMaG9tZXBhZ2VfdXJsGAkgASgJEhMKC2NvbnRhY3RfdXJsGAogASgJEgwKBGljb24YCyABKAkSLwoKY3JlYXRlZF9hdBgMIAEoCUIbukcYOhYSFDIwMjQtMDEtMTVUMDk6MDA6MDBaEi8KCnVwZGF0ZWRfYXQYDSABKAlCG7pHGDoWEhQyMDI0LTA2LTIwVDE0OjMwOjAwWhI5Cg5kZWZhdWx0X2xvY2FsZRgOIAEoDjIhLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuTG9jYWxlEjIKB2xvY2FsZXMYDyADKA4yIS5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLkxvY2FsZRIQCghwYXNzd29yZBgQIAEoCRIaChJhdXRoX2VtYWlsX2RvbWFpbnMYESADKAkSEwoLYWxsb3dfaW5kZXgYEiABKAgSGQoRYWxsb3dlZF9pcF9yYW5nZXMYEyABKAkSQQoMY3VzdG9tX3RoZW1lGBQgASgLMiYub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5DdXN0b21UaGVtZUgAiAEBQg8KDV9jdXN0b21fdGhlbWUiqQEKEVN0YXR1c1BhZ2VTdW1tYXJ5EgoKAmlkGAEgASgJEg0KBXRpdGxlGAIgASgJEgwKBHNsdWcYAyABKAkSEQoJcHVibGlzaGVkGAQgASgIEhIKCmNyZWF0ZWRfYXQYBSABKAkSEgoKdXBkYXRlZF9hdBgGIAEoCRIwCg1jdXN0b21fZG9tYWluGAcgASgJQhm6RxY6FBISc3RhdHVzLmV4YW1wbGUuY29tKsABCg5QYWdlQWNjZXNzVHlwZRIgChxQQUdFX0FDQ0VTU19UWVBFX1VOU1BFQ0lGSUVEEAASGwoXUEFHRV9BQ0NFU1NfVFlQRV9QVUJMSUMQARInCiNQQUdFX0FDQ0VTU19UWVBFX1BBU1NXT1JEX1BST1RFQ1RFRBACEiIKHlBBR0VfQUNDRVNTX1RZUEVfQVVUSEVOVElDQVRFRBADEiIKHlBBR0VfQUNDRVNTX1RZUEVfSVBfUkVTVFJJQ1RFRBAEKmkKCVBhZ2VUaGVtZRIaChZQQUdFX1RIRU1FX1VOU1BFQ0lGSUVEEAASFQoRUEFHRV9USEVNRV9TWVNURU0QARIUChBQQUdFX1RIRU1FX0xJR0hUEAISEwoPUEFHRV9USEVNRV9EQVJLEAMqegoGTG9jYWxlEhYKEkxPQ0FMRV9VTlNQRUNJRklFRBAAEg0KCUxPQ0FMRV9FThABEg0KCUxPQ0FMRV9GUhACEg0KCUxPQ0FMRV9ERRADEg0KCUxPQ0FMRV9UUhAEEg0KCUxPQ0FMRV9ISRAFEg0KCUxPQ0FMRV9LTxAGKuwBCg1PdmVyYWxsU3RhdHVzEh4KGk9WRVJBTExfU1RBVFVTX1VOU1BFQ0lGSUVEEAASHgoaT1ZFUkFMTF9TVEFUVVNfT1BFUkFUSU9OQUwQARIbChdPVkVSQUxMX1NUQVRVU19ERUdSQURFRBACEiEKHU9WRVJBTExfU1RBVFVTX1BBUlRJQUxfT1VUQUdFEAMSHwobT1ZFUkFMTF9TVEFUVVNfTUFKT1JfT1VUQUdFEAQSHgoaT1ZFUkFMTF9TVEFUVVNfTUFJTlRFTkFOQ0UQBRIaChZPVkVSQUxMX1NUQVRVU19VTktOT1dOEAYqjQEKDlBhZ2VNZXRyaWNUeXBlEiAKHFBBR0VfTUVUUklDX1RZUEVfVU5TUEVDSUZJRUQQABIdChlQQUdFX01FVFJJQ19UWVBFX0RVUkFUSU9OEAESHQoZUEFHRV9NRVRSSUNfVFlQRV9SRVFVRVNUUxACEhsKF1BBR0VfTUVUUklDX1RZUEVfTUFOVUFMEAMqYgoLUGFnZUJhclR5cGUSHQoZUEFHRV9CQVJfVFlQRV9VTlNQRUNJRklFRBAAEhoKFlBBR0VfQkFSX1RZUEVfQUJTT0xVVEUQARIYChRQQUdFX0JBUl9UWVBFX01BTlVBTBACQlpaWGdpdGh1Yi5jb20vb3BlbnN0YXR1c2hxL29wZW5zdGF0dXMvcGFja2FnZXMvcHJvdG8vb3BlbnN0YXR1cy9zdGF0dXNfcGFnZS92MTtzdGF0dXNwYWdldjFiBnByb3RvMw", [file_gnostic_openapi_v3_annotations]);
+ fileDesc("CitvcGVuc3RhdHVzL3N0YXR1c19wYWdlL3YxL3N0YXR1c19wYWdlLnByb3RvEhlvcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxIuoBCgtDdXN0b21UaGVtZRJACgVsaWdodBgBIAMoCzIxLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuQ3VzdG9tVGhlbWUuTGlnaHRFbnRyeRI+CgRkYXJrGAIgAygLMjAub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5DdXN0b21UaGVtZS5EYXJrRW50cnkaLAoKTGlnaHRFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBGisKCURhcmtFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBIsMBChFQYWdlQ29uZmlndXJhdGlvbhI+CgttZXRyaWNfdHlwZRgBIAEoDjIpLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuUGFnZU1ldHJpY1R5cGUSOAoIYmFyX3R5cGUYAiABKA4yJi5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLlBhZ2VCYXJUeXBlEhMKC3Nob3dfdXB0aW1lGAMgASgIEhEKCXRoZW1lX2tleRgEIAEoCRIMCgRkYXlzGAUgASgFItYFCgpTdGF0dXNQYWdlEgoKAmlkGAEgASgJEg0KBXRpdGxlGAIgASgJEhMKC2Rlc2NyaXB0aW9uGAMgASgJEh4KBHNsdWcYBCABKAlCELpHDToLEglhY21lLWNvcnASMAoNY3VzdG9tX2RvbWFpbhgFIAEoCUIZukcWOhQSEnN0YXR1cy5leGFtcGxlLmNvbRIRCglwdWJsaXNoZWQYBiABKAgSPgoLYWNjZXNzX3R5cGUYByABKA4yKS5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLlBhZ2VBY2Nlc3NUeXBlEjMKBXRoZW1lGAggASgOMiQub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5QYWdlVGhlbWUSFAoMaG9tZXBhZ2VfdXJsGAkgASgJEhMKC2NvbnRhY3RfdXJsGAogASgJEgwKBGljb24YCyABKAkSMQoKY3JlYXRlZF9hdBgMIAEoCUIdukcaOhgSFiIyMDI0LTAxLTE1VDA5OjAwOjAwWiISMQoKdXBkYXRlZF9hdBgNIAEoCUIdukcaOhgSFiIyMDI0LTA2LTIwVDE0OjMwOjAwWiISOQoOZGVmYXVsdF9sb2NhbGUYDiABKA4yIS5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLkxvY2FsZRIyCgdsb2NhbGVzGA8gAygOMiEub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5Mb2NhbGUSEAoIcGFzc3dvcmQYECABKAkSGgoSYXV0aF9lbWFpbF9kb21haW5zGBEgAygJEhMKC2FsbG93X2luZGV4GBIgASgIEhkKEWFsbG93ZWRfaXBfcmFuZ2VzGBMgASgJEkEKDGN1c3RvbV90aGVtZRgUIAEoCzImLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuQ3VzdG9tVGhlbWVIAIgBAUIPCg1fY3VzdG9tX3RoZW1lIqkBChFTdGF0dXNQYWdlU3VtbWFyeRIKCgJpZBgBIAEoCRINCgV0aXRsZRgCIAEoCRIMCgRzbHVnGAMgASgJEhEKCXB1Ymxpc2hlZBgEIAEoCBISCgpjcmVhdGVkX2F0GAUgASgJEhIKCnVwZGF0ZWRfYXQYBiABKAkSMAoNY3VzdG9tX2RvbWFpbhgHIAEoCUIZukcWOhQSEnN0YXR1cy5leGFtcGxlLmNvbSrAAQoOUGFnZUFjY2Vzc1R5cGUSIAocUEFHRV9BQ0NFU1NfVFlQRV9VTlNQRUNJRklFRBAAEhsKF1BBR0VfQUNDRVNTX1RZUEVfUFVCTElDEAESJwojUEFHRV9BQ0NFU1NfVFlQRV9QQVNTV09SRF9QUk9URUNURUQQAhIiCh5QQUdFX0FDQ0VTU19UWVBFX0FVVEhFTlRJQ0FURUQQAxIiCh5QQUdFX0FDQ0VTU19UWVBFX0lQX1JFU1RSSUNURUQQBCppCglQYWdlVGhlbWUSGgoWUEFHRV9USEVNRV9VTlNQRUNJRklFRBAAEhUKEVBBR0VfVEhFTUVfU1lTVEVNEAESFAoQUEFHRV9USEVNRV9MSUdIVBACEhMKD1BBR0VfVEhFTUVfREFSSxADKnoKBkxvY2FsZRIWChJMT0NBTEVfVU5TUEVDSUZJRUQQABINCglMT0NBTEVfRU4QARINCglMT0NBTEVfRlIQAhINCglMT0NBTEVfREUQAxINCglMT0NBTEVfVFIQBBINCglMT0NBTEVfSEkQBRINCglMT0NBTEVfS08QBirsAQoNT3ZlcmFsbFN0YXR1cxIeChpPVkVSQUxMX1NUQVRVU19VTlNQRUNJRklFRBAAEh4KGk9WRVJBTExfU1RBVFVTX09QRVJBVElPTkFMEAESGwoXT1ZFUkFMTF9TVEFUVVNfREVHUkFERUQQAhIhCh1PVkVSQUxMX1NUQVRVU19QQVJUSUFMX09VVEFHRRADEh8KG09WRVJBTExfU1RBVFVTX01BSk9SX09VVEFHRRAEEh4KGk9WRVJBTExfU1RBVFVTX01BSU5URU5BTkNFEAUSGgoWT1ZFUkFMTF9TVEFUVVNfVU5LTk9XThAGKo0BCg5QYWdlTWV0cmljVHlwZRIgChxQQUdFX01FVFJJQ19UWVBFX1VOU1BFQ0lGSUVEEAASHQoZUEFHRV9NRVRSSUNfVFlQRV9EVVJBVElPThABEh0KGVBBR0VfTUVUUklDX1RZUEVfUkVRVUVTVFMQAhIbChdQQUdFX01FVFJJQ19UWVBFX01BTlVBTBADKmIKC1BhZ2VCYXJUeXBlEh0KGVBBR0VfQkFSX1RZUEVfVU5TUEVDSUZJRUQQABIaChZQQUdFX0JBUl9UWVBFX0FCU09MVVRFEAESGAoUUEFHRV9CQVJfVFlQRV9NQU5VQUwQAkJaWlhnaXRodWIuY29tL29wZW5zdGF0dXNocS9vcGVuc3RhdHVzL3BhY2thZ2VzL3Byb3RvL29wZW5zdGF0dXMvc3RhdHVzX3BhZ2UvdjE7c3RhdHVzcGFnZXYxYgZwcm90bzM", [file_gnostic_openapi_v3_annotations]);
/**
* CustomTheme holds per-mode CSS variable overrides merged over the page theme.
diff --git a/packages/proto/gen/ts/openstatus/status_report/v1/service_pb.ts b/packages/proto/gen/ts/openstatus/status_report/v1/service_pb.ts
index fc02c3197..1a80db5c7 100644
--- a/packages/proto/gen/ts/openstatus/status_report/v1/service_pb.ts
+++ b/packages/proto/gen/ts/openstatus/status_report/v1/service_pb.ts
@@ -14,7 +14,7 @@ import type { Message } from "@bufbuild/protobuf";
* Describes the file openstatus/status_report/v1/service.proto.
*/
export const file_openstatus_status_report_v1_service: GenFile = /*@__PURE__*/
- fileDesc("CilvcGVuc3RhdHVzL3N0YXR1c19yZXBvcnQvdjEvc2VydmljZS5wcm90bxIbb3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxIo4EChlDcmVhdGVTdGF0dXNSZXBvcnRSZXF1ZXN0EjoKBXRpdGxlGAEgASgJQiu6RyE6HxIdQVBJIERlZ3JhZGF0aW9uIEludmVzdGlnYXRpb266SARyAhABEkkKBnN0YXR1cxgCIAEoDjIvLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5TdGF0dXNSZXBvcnRTdGF0dXNCCLpIBYIBAhABElUKB21lc3NhZ2UYAyABKAlCRLpHOjo4EjZXZSBhcmUgaW52ZXN0aWdhdGluZyByZXBvcnRzIG9mIGluY3JlYXNlZCBBUEkgbGF0ZW5jeS66SARyAhABEnQKBGRhdGUYBCABKAlCZrpHGDoWEhQyMDI0LTAzLTE1VDEwOjMwOjAwWrpISHJGMkReXGR7NH0tXGR7Mn0tXGR7Mn1UXGR7Mn06XGR7Mn06XGR7Mn0oXC5cZHsxLDl9KT8oWnxbKy1dXGR7Mn06XGR7Mn0pJBIYCgdwYWdlX2lkGAUgASgJQge6SARyAhABEhoKEnBhZ2VfY29tcG9uZW50X2lkcxgGIAMoCRITCgZub3RpZnkYByABKAhIAIgBARJHChFjb21wb25lbnRfaW1wYWN0cxgIIAMoCzIsLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5Db21wb25lbnRJbXBhY3RCCQoHX25vdGlmeSJeChpDcmVhdGVTdGF0dXNSZXBvcnRSZXNwb25zZRJACg1zdGF0dXNfcmVwb3J0GAEgASgLMikub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLlN0YXR1c1JlcG9ydCItChZHZXRTdGF0dXNSZXBvcnRSZXF1ZXN0EhMKAmlkGAEgASgJQge6SARyAhABIlsKF0dldFN0YXR1c1JlcG9ydFJlc3BvbnNlEkAKDXN0YXR1c19yZXBvcnQYASABKAsyKS5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuU3RhdHVzUmVwb3J0Iq8BChhMaXN0U3RhdHVzUmVwb3J0c1JlcXVlc3QSHQoFbGltaXQYASABKAVCCbpIBhoEGGQoAUgAiAEBEhwKBm9mZnNldBgCIAEoBUIHukgEGgIoAEgBiAEBEkEKCHN0YXR1c2VzGAMgAygOMi8ub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLlN0YXR1c1JlcG9ydFN0YXR1c0IICgZfbGltaXRCCQoHX29mZnNldCJ5ChlMaXN0U3RhdHVzUmVwb3J0c1Jlc3BvbnNlEkgKDnN0YXR1c19yZXBvcnRzGAEgAygLMjAub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLlN0YXR1c1JlcG9ydFN1bW1hcnkSEgoKdG90YWxfc2l6ZRgCIAEoBSKwAQoZVXBkYXRlU3RhdHVzUmVwb3J0UmVxdWVzdBITCgJpZBgBIAEoCUIHukgEcgIQARISCgV0aXRsZRgCIAEoCUgAiAEBEhoKEnBhZ2VfY29tcG9uZW50X2lkcxgDIAMoCRImChl1cGRhdGVfcGFnZV9jb21wb25lbnRfaWRzGAQgASgISAGIAQFCCAoGX3RpdGxlQhwKGl91cGRhdGVfcGFnZV9jb21wb25lbnRfaWRzIl4KGlVwZGF0ZVN0YXR1c1JlcG9ydFJlc3BvbnNlEkAKDXN0YXR1c19yZXBvcnQYASABKAsyKS5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuU3RhdHVzUmVwb3J0IjAKGURlbGV0ZVN0YXR1c1JlcG9ydFJlcXVlc3QSEwoCaWQYASABKAlCB7pIBHICEAEiLQoaRGVsZXRlU3RhdHVzUmVwb3J0UmVzcG9uc2USDwoHc3VjY2VzcxgBIAEoCCL4AgocQWRkU3RhdHVzUmVwb3J0VXBkYXRlUmVxdWVzdBIhChBzdGF0dXNfcmVwb3J0X2lkGAEgASgJQge6SARyAhABEkkKBnN0YXR1cxgCIAEoDjIvLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5TdGF0dXNSZXBvcnRTdGF0dXNCCLpIBYIBAhABEhgKB21lc3NhZ2UYAyABKAlCB7pIBHICEAESXgoEZGF0ZRgEIAEoCUJLukhIckYyRF5cZHs0fS1cZHsyfS1cZHsyfVRcZHsyfTpcZHsyfTpcZHsyfShcLlxkezEsOX0pPyhafFsrLV1cZHsyfTpcZHsyfSkkSACIAQESEwoGbm90aWZ5GAUgASgISAGIAQESRwoRY29tcG9uZW50X2ltcGFjdHMYBiADKAsyLC5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuQ29tcG9uZW50SW1wYWN0QgcKBV9kYXRlQgkKB19ub3RpZnkiYQodQWRkU3RhdHVzUmVwb3J0VXBkYXRlUmVzcG9uc2USQAoNc3RhdHVzX3JlcG9ydBgBIAEoCzIpLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5TdGF0dXNSZXBvcnQyvwsKE1N0YXR1c1JlcG9ydFNlcnZpY2USzgMKEkNyZWF0ZVN0YXR1c1JlcG9ydBI2Lm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5DcmVhdGVTdGF0dXNSZXBvcnRSZXF1ZXN0Gjcub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkNyZWF0ZVN0YXR1c1JlcG9ydFJlc3BvbnNlIsYCukfCAhq/AkNyZWF0ZXMgYSBuZXcgc3RhdHVzIHJlcG9ydCB3aXRoIGFuIGluaXRpYWwgdXBkYXRlIGVudHJ5LiBUaGUgcmVwb3J0IGlzIGFzc29jaWF0ZWQgd2l0aCBhIHN0YXR1cyBwYWdlIGFuZCBvcHRpb25hbGx5IHNwZWNpZmljIHBhZ2UgY29tcG9uZW50cy4gQW4gaW5pdGlhbCBTdGF0dXNSZXBvcnRVcGRhdGUgaXMgY3JlYXRlZCBhdXRvbWF0aWNhbGx5IHdpdGggdGhlIHByb3ZpZGVkIHN0YXR1cywgbWVzc2FnZSwgYW5kIGRhdGUuIElmIG5vdGlmeSBpcyB0cnVlLCBzdWJzY3JpYmVycyBvZiB0aGUgYXNzb2NpYXRlZCBwYWdlIGFyZSBub3RpZmllZCBieSBlbWFpbC4SgQEKD0dldFN0YXR1c1JlcG9ydBIzLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5HZXRTdGF0dXNSZXBvcnRSZXF1ZXN0GjQub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkdldFN0YXR1c1JlcG9ydFJlc3BvbnNlIgOQAgEShwEKEUxpc3RTdGF0dXNSZXBvcnRzEjUub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkxpc3RTdGF0dXNSZXBvcnRzUmVxdWVzdBo2Lm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5MaXN0U3RhdHVzUmVwb3J0c1Jlc3BvbnNlIgOQAgEShQEKElVwZGF0ZVN0YXR1c1JlcG9ydBI2Lm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5VcGRhdGVTdGF0dXNSZXBvcnRSZXF1ZXN0Gjcub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLlVwZGF0ZVN0YXR1c1JlcG9ydFJlc3BvbnNlEoUBChJEZWxldGVTdGF0dXNSZXBvcnQSNi5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuRGVsZXRlU3RhdHVzUmVwb3J0UmVxdWVzdBo3Lm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5EZWxldGVTdGF0dXNSZXBvcnRSZXNwb25zZRK4AwoVQWRkU3RhdHVzUmVwb3J0VXBkYXRlEjkub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkFkZFN0YXR1c1JlcG9ydFVwZGF0ZVJlcXVlc3QaOi5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuQWRkU3RhdHVzUmVwb3J0VXBkYXRlUmVzcG9uc2UipwK6R6MCGqACQWRkcyBhIG5ldyB1cGRhdGUgZW50cnkgdG8gYW4gZXhpc3Rpbmcgc3RhdHVzIHJlcG9ydCBhbmQgdHJhbnNpdGlvbnMgdGhlIHJlcG9ydCB0byB0aGUgc3BlY2lmaWVkIHN0YXR1cy4gU3RhdHVzIHJlcG9ydHMgZm9sbG93IGEgbGlmZWN5Y2xlOiBpbnZlc3RpZ2F0aW5nIC0+IGlkZW50aWZpZWQgLT4gbW9uaXRvcmluZyAtPiByZXNvbHZlZC4gSWYgbm90aWZ5IGlzIHRydWUsIHN1YnNjcmliZXJzIG9mIHRoZSBhc3NvY2lhdGVkIHBhZ2UgYXJlIG5vdGlmaWVkIGJ5IGVtYWlsIGFib3V0IHRoZSB1cGRhdGUuQl5aXGdpdGh1Yi5jb20vb3BlbnN0YXR1c2hxL29wZW5zdGF0dXMvcGFja2FnZXMvcHJvdG8vb3BlbnN0YXR1cy9zdGF0dXNfcmVwb3J0L3YxO3N0YXR1c3JlcG9ydHYxYgZwcm90bzM", [file_buf_validate_validate, file_gnostic_openapi_v3_annotations, file_openstatus_status_report_v1_status_report]);
+ fileDesc("CilvcGVuc3RhdHVzL3N0YXR1c19yZXBvcnQvdjEvc2VydmljZS5wcm90bxIbb3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxIpAEChlDcmVhdGVTdGF0dXNSZXBvcnRSZXF1ZXN0EjoKBXRpdGxlGAEgASgJQiu6RyE6HxIdQVBJIERlZ3JhZGF0aW9uIEludmVzdGlnYXRpb266SARyAhABEkkKBnN0YXR1cxgCIAEoDjIvLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5TdGF0dXNSZXBvcnRTdGF0dXNCCLpIBYIBAhABElUKB21lc3NhZ2UYAyABKAlCRLpHOjo4EjZXZSBhcmUgaW52ZXN0aWdhdGluZyByZXBvcnRzIG9mIGluY3JlYXNlZCBBUEkgbGF0ZW5jeS66SARyAhABEnYKBGRhdGUYBCABKAlCaLpHGjoYEhYiMjAyNC0wMy0xNVQxMDozMDowMFoiukhIckYyRF5cZHs0fS1cZHsyfS1cZHsyfVRcZHsyfTpcZHsyfTpcZHsyfShcLlxkezEsOX0pPyhafFsrLV1cZHsyfTpcZHsyfSkkEhgKB3BhZ2VfaWQYBSABKAlCB7pIBHICEAESGgoScGFnZV9jb21wb25lbnRfaWRzGAYgAygJEhMKBm5vdGlmeRgHIAEoCEgAiAEBEkcKEWNvbXBvbmVudF9pbXBhY3RzGAggAygLMiwub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkNvbXBvbmVudEltcGFjdEIJCgdfbm90aWZ5Il4KGkNyZWF0ZVN0YXR1c1JlcG9ydFJlc3BvbnNlEkAKDXN0YXR1c19yZXBvcnQYASABKAsyKS5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuU3RhdHVzUmVwb3J0Ii0KFkdldFN0YXR1c1JlcG9ydFJlcXVlc3QSEwoCaWQYASABKAlCB7pIBHICEAEiWwoXR2V0U3RhdHVzUmVwb3J0UmVzcG9uc2USQAoNc3RhdHVzX3JlcG9ydBgBIAEoCzIpLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5TdGF0dXNSZXBvcnQirwEKGExpc3RTdGF0dXNSZXBvcnRzUmVxdWVzdBIdCgVsaW1pdBgBIAEoBUIJukgGGgQYZCgBSACIAQESHAoGb2Zmc2V0GAIgASgFQge6SAQaAigASAGIAQESQQoIc3RhdHVzZXMYAyADKA4yLy5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuU3RhdHVzUmVwb3J0U3RhdHVzQggKBl9saW1pdEIJCgdfb2Zmc2V0InkKGUxpc3RTdGF0dXNSZXBvcnRzUmVzcG9uc2USSAoOc3RhdHVzX3JlcG9ydHMYASADKAsyMC5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuU3RhdHVzUmVwb3J0U3VtbWFyeRISCgp0b3RhbF9zaXplGAIgASgFIrABChlVcGRhdGVTdGF0dXNSZXBvcnRSZXF1ZXN0EhMKAmlkGAEgASgJQge6SARyAhABEhIKBXRpdGxlGAIgASgJSACIAQESGgoScGFnZV9jb21wb25lbnRfaWRzGAMgAygJEiYKGXVwZGF0ZV9wYWdlX2NvbXBvbmVudF9pZHMYBCABKAhIAYgBAUIICgZfdGl0bGVCHAoaX3VwZGF0ZV9wYWdlX2NvbXBvbmVudF9pZHMiXgoaVXBkYXRlU3RhdHVzUmVwb3J0UmVzcG9uc2USQAoNc3RhdHVzX3JlcG9ydBgBIAEoCzIpLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5TdGF0dXNSZXBvcnQiMAoZRGVsZXRlU3RhdHVzUmVwb3J0UmVxdWVzdBITCgJpZBgBIAEoCUIHukgEcgIQASItChpEZWxldGVTdGF0dXNSZXBvcnRSZXNwb25zZRIPCgdzdWNjZXNzGAEgASgIIvgCChxBZGRTdGF0dXNSZXBvcnRVcGRhdGVSZXF1ZXN0EiEKEHN0YXR1c19yZXBvcnRfaWQYASABKAlCB7pIBHICEAESSQoGc3RhdHVzGAIgASgOMi8ub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLlN0YXR1c1JlcG9ydFN0YXR1c0IIukgFggECEAESGAoHbWVzc2FnZRgDIAEoCUIHukgEcgIQARJeCgRkYXRlGAQgASgJQku6SEhyRjJEXlxkezR9LVxkezJ9LVxkezJ9VFxkezJ9OlxkezJ9OlxkezJ9KFwuXGR7MSw5fSk/KFp8WystXVxkezJ9OlxkezJ9KSRIAIgBARITCgZub3RpZnkYBSABKAhIAYgBARJHChFjb21wb25lbnRfaW1wYWN0cxgGIAMoCzIsLm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5Db21wb25lbnRJbXBhY3RCBwoFX2RhdGVCCQoHX25vdGlmeSJhCh1BZGRTdGF0dXNSZXBvcnRVcGRhdGVSZXNwb25zZRJACg1zdGF0dXNfcmVwb3J0GAEgASgLMikub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLlN0YXR1c1JlcG9ydDK/CwoTU3RhdHVzUmVwb3J0U2VydmljZRLOAwoSQ3JlYXRlU3RhdHVzUmVwb3J0EjYub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkNyZWF0ZVN0YXR1c1JlcG9ydFJlcXVlc3QaNy5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuQ3JlYXRlU3RhdHVzUmVwb3J0UmVzcG9uc2UixgK6R8ICGr8CQ3JlYXRlcyBhIG5ldyBzdGF0dXMgcmVwb3J0IHdpdGggYW4gaW5pdGlhbCB1cGRhdGUgZW50cnkuIFRoZSByZXBvcnQgaXMgYXNzb2NpYXRlZCB3aXRoIGEgc3RhdHVzIHBhZ2UgYW5kIG9wdGlvbmFsbHkgc3BlY2lmaWMgcGFnZSBjb21wb25lbnRzLiBBbiBpbml0aWFsIFN0YXR1c1JlcG9ydFVwZGF0ZSBpcyBjcmVhdGVkIGF1dG9tYXRpY2FsbHkgd2l0aCB0aGUgcHJvdmlkZWQgc3RhdHVzLCBtZXNzYWdlLCBhbmQgZGF0ZS4gSWYgbm90aWZ5IGlzIHRydWUsIHN1YnNjcmliZXJzIG9mIHRoZSBhc3NvY2lhdGVkIHBhZ2UgYXJlIG5vdGlmaWVkIGJ5IGVtYWlsLhKBAQoPR2V0U3RhdHVzUmVwb3J0EjMub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkdldFN0YXR1c1JlcG9ydFJlcXVlc3QaNC5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuR2V0U3RhdHVzUmVwb3J0UmVzcG9uc2UiA5ACARKHAQoRTGlzdFN0YXR1c1JlcG9ydHMSNS5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuTGlzdFN0YXR1c1JlcG9ydHNSZXF1ZXN0GjYub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkxpc3RTdGF0dXNSZXBvcnRzUmVzcG9uc2UiA5ACARKFAQoSVXBkYXRlU3RhdHVzUmVwb3J0EjYub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLlVwZGF0ZVN0YXR1c1JlcG9ydFJlcXVlc3QaNy5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuVXBkYXRlU3RhdHVzUmVwb3J0UmVzcG9uc2UShQEKEkRlbGV0ZVN0YXR1c1JlcG9ydBI2Lm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5EZWxldGVTdGF0dXNSZXBvcnRSZXF1ZXN0Gjcub3BlbnN0YXR1cy5zdGF0dXNfcmVwb3J0LnYxLkRlbGV0ZVN0YXR1c1JlcG9ydFJlc3BvbnNlErgDChVBZGRTdGF0dXNSZXBvcnRVcGRhdGUSOS5vcGVuc3RhdHVzLnN0YXR1c19yZXBvcnQudjEuQWRkU3RhdHVzUmVwb3J0VXBkYXRlUmVxdWVzdBo6Lm9wZW5zdGF0dXMuc3RhdHVzX3JlcG9ydC52MS5BZGRTdGF0dXNSZXBvcnRVcGRhdGVSZXNwb25zZSKnArpHowIaoAJBZGRzIGEgbmV3IHVwZGF0ZSBlbnRyeSB0byBhbiBleGlzdGluZyBzdGF0dXMgcmVwb3J0IGFuZCB0cmFuc2l0aW9ucyB0aGUgcmVwb3J0IHRvIHRoZSBzcGVjaWZpZWQgc3RhdHVzLiBTdGF0dXMgcmVwb3J0cyBmb2xsb3cgYSBsaWZlY3ljbGU6IGludmVzdGlnYXRpbmcgLT4gaWRlbnRpZmllZCAtPiBtb25pdG9yaW5nIC0+IHJlc29sdmVkLiBJZiBub3RpZnkgaXMgdHJ1ZSwgc3Vic2NyaWJlcnMgb2YgdGhlIGFzc29jaWF0ZWQgcGFnZSBhcmUgbm90aWZpZWQgYnkgZW1haWwgYWJvdXQgdGhlIHVwZGF0ZS5CXlpcZ2l0aHViLmNvbS9vcGVuc3RhdHVzaHEvb3BlbnN0YXR1cy9wYWNrYWdlcy9wcm90by9vcGVuc3RhdHVzL3N0YXR1c19yZXBvcnQvdjE7c3RhdHVzcmVwb3J0djFiBnByb3RvMw", [file_buf_validate_validate, file_gnostic_openapi_v3_annotations, file_openstatus_status_report_v1_status_report]);
/**
* CreateStatusReportRequest is the request to create a new status report.