read_platform_status
Generated automatically from the published contract sources.
Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.
A script calls this action over HTTPS at POST https://turnzero.ai/api/v1/actions/read_platform_status, with a bearer credential and the action's payload as the JSON body. It also accepts GET.
Contract description
Read the platform's own status document. Super-admin (platform operator) only. The document holds the overall state, the open incidents, every component's state and timeline, the availability figures, the control plane's signals, the background passes, the capacity rows, the watches, the watched conditions, and the incident history. Its `settings` section answers each status setting as stored, the one read of a switch that writes nothing. The `summary_text` member is the one-paragraph rendering to print for a "show me the status" ask; `sections` reads a subset.
Access and action metadata
{
"name": "read_platform_status",
"resource": "account",
"tier": "observe",
"clients": [
"bearer",
"browser_session"
],
"grant": "super_admin",
"summary": "Super-admin: the platform's own status document, composed on the plane from the status record and the registry rows with no HTTP call and no read of the hosting subscription — the overall state and the open incidents, one row per component with its state and 60-minute timeline, the availability figures over four windows, the control plane's route and pool signals, the background passes and their backlogs, the capacity rows with headroom and days to exhaustion, the watches, the watched conditions, and the incidents opened within `history_days` (30 by default, 365 at most); `sections` names a subset, and a section whose read failed is named in `sections_unavailable`. Its `settings` section answers each status setting as stored, the one read of a switch that writes nothing.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"openWorldHint": false,
"idempotentHint": true
}
}
MCP catalog entry
{
"name": "read_platform_status",
"tier": "observe",
"scenario": "API-L0-12",
"summary": "Read the platform's own status document. Super-admin (platform operator) only. The document holds the overall state, the open incidents, every component's state and timeline, the availability figures, the control plane's signals, the background passes, the capacity rows, the watches, the watched conditions, and the incident history. Its `settings` section answers each status setting as stored, the one read of a switch that writes nothing. The `summary_text` member is the one-paragraph rendering to print for a \"show me the status\" ask; `sections` reads a subset.",
"owners": []
}
request
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | Type: object Required fields: [] |
| / |
The window of the incidents section and of the changes section's last closed incident, in days before the read: 30 where none is given, 365 at most. A decimal string of the integer is admitted too, the query string's spelling, on GET and on POST alike; any other form refuses invalid_request naming the member. Type: integer Minimum: 1 Maximum: 365 |
| / |
The sections to compose; every section where absent. A section not named is absent from the answer and its reads do not run. One string names one section, on GET and on POST alike; on GET the member repeated (`?sections=now§ions=components`) is the list. The value `read` is not a section name. An unknown name, an empty list, a comma-joined string, or a member of another type refuses invalid_request naming the member. Type: array Minimum items: 1 |
| / |
Type: string Allowed values: ["now","components","changes","availability","plane_signals","background_work","capacity","watches","conditions","incidents","azure","settings"] |
response
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | The status document: `read` always, then each requested section that composed, each absent where not requested or where its read failed (then named in read.sections_unavailable). Every instant is ISO 8601 in UTC. Type: object Required fields: ["contract_version","read"] Additional properties: false |
| / |
Required value: 1 |
| / |
always present: the read's own facts, composed last from what succeeded Type: object Required fields: ["as_of","contract_version","build","history_days","sections_unavailable","summary_text"] |
| / |
the instant of the read, ISO 8601 in UTC Type: string |
| / |
Required value: 1 |
| / |
the control plane's own build stamp: the commit it was built from, whether the tree was dirty, and the build instant Type: object Required fields: ["source_commit","dirty","built_at"] |
| / |
Type: ["string","null"] |
| / |
Type: ["boolean","null"] |
| / |
Type: ["string","null"] |
| / |
the window applied Type: integer |
| / |
each requested section whose composition failed, the section then absent. The detail is the fixed sentence `An unexpected error occurred; quote reference <reference> when reporting it.`, the control plane's own record holding the error under that reference and never the error's message (PLD-L0-80). It includes `azure` while the record holds no azure_* reading, the reason saying the hourly pass has not written one or naming the newest pass and its failed reads Type: array |
| / |
Type: object Required fields: ["section","detail"] |
| / |
Type: string Allowed values: ["now","components","changes","availability","plane_signals","background_work","capacity","watches","conditions","incidents","azure","settings"] |
| / |
Type: string |
| / |
the one-paragraph rendering: at most seventeen ASCII lines, one fact each. The lines hold the overall state as of the newest plane minute, the components not up, and the open incidents (five at most, one per row, then the count of the rest). They also hold the watched conditions open and failing (five subjects at most per state, then the count of the rest) and the overdue passes. They hold the nearest limits (three at most, one per row under their header), the hosting provider's line where that section composed, and the sections unavailable. It is the same text the status page's first section shows and a connected session prints for a "show me the status" ask Type: string |
| / |
the platform right now: the overall state, the newest plane minute and whether it is stale, the open incidents, the worst component, the serving build, and the last change Type: object Required fields: ["overall","as_of_minute","stale","open_incidents","worst","serving_build","last_change"] |
| / |
the platform's overall state from the components' standings Type: string Allowed values: ["ok","degraded","down","unknown"] |
| / |
the newest plane.management sample's minute, ISO 8601 in UTC, or null Type: ["string","null"] |
| / |
true where that minute is older than the stale bound before the read Type: boolean |
| / |
the open incidents, newest opened first Type: array |
| / |
the row shape record_incident answers as `incident`: id, kind, state, opened_at, first_failure_at, closed_at, duration_ms, title, components, summary, cause, detection_source, author, updates, retirements Type: object |
| / |
the first component in the order down, degraded, unknown, by the earliest since: component, state, since; null where every component is up Type: ["object","null"] |
| / |
the plane's serving build: source_commit and first_seen, the least minute of the newest run of samples carrying the pair (build, bundle_hash), a sample carrying neither member neither extending nor breaking the run and a change in either member starting a new one Type: ["object","null"] |
| / |
the newest since among the components, the last state change, ISO 8601 in UTC, or null Type: ["string","null"] |
| / |
every component's state, its newest sample, and its 60-minute timeline Type: object Required fields: ["rows"] |
| / |
one row per component the pass probes, plus every component the record has sampled that the current list no longer names, rendered retired Type: array |
| / |
Type: object Required fields: ["name","state","since","newest_minute","ready","status","latency_ms","build","bundle_hash","detail","consecutive_failed","omitted","timeline"] |
| / |
Type: string |
| / |
Type: string Allowed values: ["up","degraded","down","unknown","retired"] |
| / |
the minute the current run began, ISO 8601 in UTC, or null Type: ["string","null"] |
| / |
the newest sample's minute, ISO 8601 in UTC, or null Type: ["string","null"] |
| / |
the newest sample's readiness Type: ["boolean","null"] |
| / |
the newest sample's HTTP status Type: ["integer","null"] |
| / |
the newest sample's latency Type: ["integer","null"] |
| / |
the build the newest sample reported Type: ["string","null"] |
| / |
the bundle hash the newest sample reported beside its build: the body's build.bundle_hash (MAPI-13), or for plane.management the process's own; null where the body carried none and on a failed sample Type: ["string","null"] |
| / |
the newest sample's detail Type: ["string","null"] |
| / |
the count of leading failed samples, newest first Type: integer |
| / |
why the pass omits the component, where it does; such a component has state unknown and no sample Type: ["string","null"] |
| / |
sixty marks, one per minute, newest last: o for an ok sample, x for a failed one, ? for none Type: string |
| / |
what changed recently: the serving builds, the newest migrations of the two databases, the last finished actions, and the last closed incident Type: object Required fields: ["builds","migrations","finished_actions","last_incident_closed"] |
| / |
each component's serving build with its bundle hash and when the pair was first seen Type: array |
| / |
component, build, bundle_hash, and first_seen, the least minute of the newest run of samples carrying that pair (build, bundle_hash): a sample carrying neither member neither extends nor breaks the run, and a change in either member starts a new run Type: object |
| / |
control and logging, each the newest applied migration as name and applied_at, or null where the ledger is absent Type: object |
| / |
the ten newest pending actions in a terminal state, newest finished first Type: array |
| / |
action, actor, requested_at, finished_at, and state Type: object |
| / |
the newest closed incident within history_days, or null; the row shape record_incident answers as `incident`: id, kind, state, opened_at, first_failure_at, closed_at, duration_ms, title, components, summary, cause, detection_source, author, updates, retirements Type: ["object","null"] |
| / |
the availability figures per component and window beside the objective Type: object Required fields: ["objective","components"] |
| / |
the availability objective: value (null while not yet set), the statement that owns it, and the detail saying where the value comes from Type: object |
| / |
each component's availability over the four windows, counted from the stored samples and day rows Type: array |
| / |
component, first_minute, last_minute, and windows: one entry per window with window, minutes_considered, ok_minutes, failed_minutes, unknown_minutes, figure (null with the reason where no minute was measured), reason, and partial Type: object |
| / |
the control plane's own counters over two bucket-aligned windows: last_hour the current UTC hour's bucket so far, last_24h every hour bucket from the one holding as_of − 24h through the current hour's (25 at most). They are composed from the same store read read_control_plane_counters makes Type: object Required fields: ["routes","pools","schedule_tick","realm"] |
| / |
keyed by route class: the requests, the 5xx count, the latency bands, and the mean over two bucket-aligned windows. The windows are last_hour, the current UTC hour's bucket so far, and last_24h, every hour bucket from the one holding as_of − 24h through the current hour's (25 at most) Type: object |
| / |
Type: object Required fields: ["last_hour","last_24h"] |
| / |
the counters of one window: requests, status_5xx, latency (le_50ms, le_200ms, le_1000ms, gt_1000ms), and mean_ms (ms_total / requests, null at zero requests) Type: object |
| / |
the counters of one window: requests, status_5xx, latency (le_50ms, le_200ms, le_1000ms, gt_1000ms), and mean_ms (ms_total / requests, null at zero requests) Type: object |
| / |
keyed by pool name: the waiting seconds, the saturated seconds, and the failover retries over two bucket-aligned windows. The windows are last_hour, the current UTC hour's bucket so far, and last_24h, every hour bucket from the one holding as_of − 24h through the current hour's (25 at most) Type: object |
| / |
Type: object Required fields: ["last_hour","last_24h"] |
| / |
the counters of one window: waiting_seconds, saturated_seconds, and failover_retries Type: object |
| / |
the counters of one window: waiting_seconds, saturated_seconds, and failover_retries Type: object |
| / |
Type: object Required fields: ["last_hour","last_24h"] |
| / |
Type: integer |
| / |
Type: integer |
| / |
reissues and reissue_refusals, each over two bucket-aligned windows: last_hour the current UTC hour's bucket so far, last_24h every hour bucket from the one holding as_of − 24h through the current hour's (25 at most) Type: object |
| / |
the background passes and the backlogs: executing actions, deploying versions, and schedule runs Type: object Required fields: ["passes","executing","deploying","schedule_runs_running","schedule_runs_24h"] |
| / |
every background pass with its last run and whether it is overdue Type: array |
| / |
pass, interval_ms (null where the pass has no interval), last_ran and last_failed (each a pass run — pass, replica, started_at, ended_at, outcome, detail — or null). It also carries stale, true where the last run is older than twice the interval, or where the pass has never run and the record began longer ago than that (its first migration; PLD-L0-76) Type: object |
| / |
the pending actions in state executing, oldest first Type: array |
| / |
id, action, actor, and executing_at Type: object |
| / |
every version row still deploying, oldest heartbeat first Type: array |
| / |
application, environment, version, and heartbeat_at Type: object |
| / |
the schedule runs in flight, oldest first Type: array |
| / |
application, environment, schedule, and started_at Type: object |
| / |
the count of schedule runs per outcome due in the last 24 hours Type: object |
| / |
Type: integer |
| / |
the capacity rows: each reading against its ceiling, with the headroom, the flag, and the days to exhaustion where a rate can be read Type: object Required fields: ["rows"] |
| / |
one row per reading kind and subject, with its ceiling, headroom, and rate Type: array |
| / |
Type: object Required fields: ["kind","subject","read_at","value","ceiling","headroom_percent","flagged","growth_per_day","days_to_exhaustion","reason","detail"] |
| / |
the reading kind: placements_cell, placements_group, awake_group, server_databases, server_storage_bytes, server_backends, applications, accounts, control_db_bytes, logging_db_bytes, certificate_days, log_ingestion_gb, cost_month_to_date, email_sends_hour, plane_pools, or azure_quota Type: string |
| / |
the cell, group, server, pool, hostname, or the one subject of a platform-wide kind Type: string |
| / |
the instant the value was read: the read itself for a live count, the newest stored reading otherwise, ISO 8601 in UTC, or null Type: ["string","null"] |
| / |
the reading; null where no reading exists yet Type: ["number","null"] |
| / |
the bound the value is measured against: a registry nominal capacity, a server bound, a storage setting, the ingestion cap, or the email ceiling; null where unknown Type: ["number","null"] |
| / |
100 × (1 − value / ceiling); null where either is unknown Type: ["number","null"] |
| / |
true where the used fraction is at or above the headroom flag Type: boolean |
| / |
the least-squares slope over the readings of the last eight days where at least seven readings on distinct days exist and the slope is positive; null otherwise Type: ["number","null"] |
| / |
(ceiling − value) / growth_per_day where both are known; null otherwise Type: ["number","null"] |
| / |
why a rate or a ceiling is absent: fewer than seven readings, zero or negative growth, ceiling unknown, no reading yet, or not read at this revision Type: ["string","null"] |
| / |
The ceiling's provenance where it has one: the storage setting's last apply (autogrow can raise the live value between applies) or the setting's absence for a database size row, the pool max over the replicas for a plane_pools row. For the accounts row, `open_sign_ups=<count>`, the builder realm's open sign-up count its creation ceiling reads; null otherwise. Type: ["string","null"] |
| / |
the watches: the certificates, the log ingestion, the cost, the email sends, and the release drift Type: object Required fields: ["certificates","log_ingestion","cost","email_sends","release_drift"] |
| / |
one row per certificate hostname, from the newest certificate_days reading Type: array |
| / |
Type: object Required fields: ["subject","read_at","days_to_expiry","reason"] |
| / |
the certificate hostname Type: string |
| / |
the instant of the newest certificate_days reading, ISO 8601 in UTC, or null where none exists Type: ["string","null"] |
| / |
the newest certificate_days reading's value, the days until the certificate expires; null where no reading exists Type: ["number","null"] |
| / |
why the value is absent: no reading yet; or `stale` where the newest reading is older than twice the daily pass's interval, the value shown being that reading; null otherwise Type: ["string","null"] |
| / |
the log ingestion against its daily cap, from the newest log_ingestion_gb reading Type: object Required fields: ["read_at","ingested_gb","daily_cap_gb","headroom_percent","reset_at","reason"] |
| / |
the instant of the newest log_ingestion_gb reading, ISO 8601 in UTC, or null where none exists Type: ["string","null"] |
| / |
the newest log_ingestion_gb reading's value, the gigabytes ingested in the workspace's current day; null where no reading exists Type: ["number","null"] |
| / |
that reading's bound, the daily cap; null where unknown Type: ["number","null"] |
| / |
100 × (1 − ingested_gb / daily_cap_gb); null where either is unknown Type: ["number","null"] |
| / |
the instant the daily cap resets, from the reading's detail, ISO 8601 in UTC, or null where the reading carries none Type: ["string","null"] |
| / |
why the value is absent: no reading yet; or `stale` where the newest reading is older than twice the daily pass's interval, the value shown being that reading; null otherwise Type: ["string","null"] |
| / |
the month-to-date cost and its projection to the month's end Type: object Required fields: ["month_to_date","read_at","projected_month_end","reason"] |
| / |
the newest cost_month_to_date reading of the calendar month; null where none exists Type: ["number","null"] |
| / |
the instant of the newest cost_month_to_date reading, ISO 8601 in UTC, or null where none exists Type: ["string","null"] |
| / |
a linear projection to the month's end, the burn between the month's first reading in the window and the newest carried forward; null where fewer than two readings exist or the newest reading is stale Type: ["number","null"] |
| / |
why the value is absent: no reading yet; `stale` where the newest reading is older than twice the daily pass's interval, the value shown being that reading and the projection withheld; or fewer than two readings this month for the projection; null otherwise Type: ["string","null"] |
| / |
the email sends against the hourly ceiling, from the newest email_sends_hour reading Type: object Required fields: ["read_at","sends","bound","headroom_percent","reason"] |
| / |
the instant of the newest email_sends_hour reading, ISO 8601 in UTC, or null where none exists Type: ["string","null"] |
| / |
the newest email_sends_hour reading's value, the sends in the hour; null where no reading exists Type: ["number","null"] |
| / |
that reading's bound, the hourly ceiling; null where unknown Type: ["number","null"] |
| / |
100 × (1 − sends / bound); null where either is unknown Type: ["number","null"] |
| / |
why the value is absent: no reading yet; or `stale` where the newest reading is older than twice the daily pass's interval, the value shown being that reading; null otherwise Type: ["string","null"] |
| / |
the release drift: whether any standing component that runs the plane image serves a build other than the plane's own, and which Type: object Required fields: ["drifted","components"] |
| / |
true where components is not empty Type: boolean |
| / |
each standing component (neither retired nor omitted) that runs the plane image — plane.management, plane.accounts, plane.internal, edge.management, edge.gateways, and `shard.<id>.gateway_public` and `shard.<id>.gateway_private` for every routing tier — whose newest sample reports a build other than the plane's own, with that build. The router and the egress seat are outside the watch, their bundles built at their own roll commits. Empty where the plane's own build is unknown Type: array |
| / |
Type: object Required fields: ["component","build"] |
| / |
the component name Type: string |
| / |
the build its newest sample reports Type: string |
| / |
the watched conditions (the incident record's condition source): the newest run that held its claim, and one row per subject with its state, the fact the operator acts on Type: object Required fields: ["evaluated_at","reason","rows"] |
| / |
the instant of the newest conditions-pass run that held its claim and ran; null with `reason` where no such run stands Type: ["string","null"] |
| / |
why `evaluated_at` is null; null where it is present Type: ["string","null"] |
| / |
one row per subject the record holds, in subject order Type: array |
| / |
Type: object Required fields: ["subject","state","since","detail","incident"] |
| / |
the watched subject, `condition.<name>` or `condition.<name>.<segment>` Type: string |
| / |
`open` where the row names an open incident, `suppressed` where a planned incident naming the subject or naming no component suppresses a failing evaluation, `failing` where the failing run is above zero with no incident, `clear` otherwise Type: string Allowed values: ["clear","failing","open","suppressed"] |
| / |
the current failing run's first instant, or the last evaluation where the subject is not failing Type: ["string","null"] |
| / |
names, classes, and counts, never an error's message Type: ["string","null"] |
| / |
the incident the row names, open or hand-closed; null where it names none Type: ["string","null"] |
| / |
the incident record: the open incidents and the history within the window Type: object Required fields: ["open","history"] |
| / |
the open incidents, newest opened first Type: array |
| / |
the row shape record_incident answers as `incident`: id, kind, state, opened_at, first_failure_at, closed_at, duration_ms, title, components, summary, cause, detection_source, author, updates, retirements Type: object |
| / |
the incidents opened within history_days that are not open, newest opened first Type: array |
| / |
the row shape record_incident answers as `incident`: id, kind, state, opened_at, first_failure_at, closed_at, duration_ms, title, components, summary, cause, detection_source, author, updates, retirements Type: object |
| / |
what the hosting provider itself measures, read by the hourly provider readings pass under the status-reader role and stored as platform_readings (PLD-L0-76). The section is composed from those readings alone. It is absent while no azure_* reading exists, the section then named in sections_unavailable with the reason. A reading is never made at read time Type: object Required fields: ["read_at","alerts","origin_health","servers","resource_health","service_issues","certificate_order","failed_reads"] |
| / |
the newest pass's start instant, ISO 8601 in UTC; the newest reading's instant where no pass row stands Type: ["string","null"] |
| / |
Type: object Required fields: ["since","rows"] |
| / |
the start of the window the rows cover, 30 days before the read, ISO 8601 in UTC Type: string |
| / |
every alert instance that started in the window, newest first Type: array |
| / |
Type: object Required fields: ["id","rule","target","severity","condition","started","resolved","description","declared"] |
| / |
the alert's name as the provider reports it, the rule's name; the row's key is that name with the instance's start Type: string |
| / |
the rule's name, the last segment of its resource id Type: string |
| / |
the target resource's name Type: ["string","null"] |
| / |
the severity as the provider names it, Sev0 to Sev4 Type: ["string","null"] |
| / |
the monitor condition at the newest reading Type: string Allowed values: ["Fired","Resolved"] |
| / |
the instance start, ISO 8601 in UTC Type: string |
| / |
the resolution instant where resolved, ISO 8601 in UTC Type: ["string","null"] |
| / |
the rule's description as the instance carries it, at most 200 characters Type: ["string","null"] |
| / |
whether the rule's key is one the five rule-declaring templates declare Type: boolean |
| / |
Type: object Required fields: ["rows"] |
| / |
the last 24 hours, by origin group then hour Type: array |
| / |
Type: object Required fields: ["origin_group","hour","minimum_percent","mean_percent","samples"] |
| / |
the edge profile's origin group Type: string |
| / |
the start of the hour the reading covers, ISO 8601 in UTC Type: string |
| / |
the hour's minimum OriginHealthPercentage Type: ["number","null"] |
| / |
the hour's mean OriginHealthPercentage Type: ["number","null"] |
| / |
the minutes with a value in the hour Type: ["number","null"] |
| / |
Type: object Required fields: ["rows"] |
| / |
the last 24 hours, by host then hour Type: array |
| / |
Type: object Required fields: ["host","hour","down_minutes","samples","registry"] |
| / |
the flexible server's host name Type: string |
| / |
the start of the hour the reading covers, ISO 8601 in UTC Type: string |
| / |
the minutes whose is_db_alive maximum was 0 Type: ["number","null"] |
| / |
the minutes with a value in the hour Type: ["number","null"] |
| / |
true for a host the registry servers rows name, false for a control-tier host Type: boolean |
| / |
Type: object Required fields: ["rows"] |
| / |
the newest reading per resource of the plane, routing tier, and cell groups Type: array |
| / |
Type: object Required fields: ["resource","state","summary","read_at"] |
| / |
the resource below its group: group/provider/type/name Type: string |
| / |
Resource Health's availability state: Available, Unavailable, Degraded, or Unknown Type: string |
| / |
Resource Health's summary, at most 200 characters Type: ["string","null"] |
| / |
the instant of the reading, ISO 8601 in UTC Type: string |
| / |
Type: object Required fields: ["rows"] |
| / |
the service issues read in the last 30 days that name the region or are global and are Active or started or last updated within the last three days, newest first Type: array |
| / |
Type: object Required fields: ["id","title","level","status","services","started","updated"] |
| / |
the event's tracking id Type: string |
| / |
the event's title Type: ["string","null"] |
| / |
the event's level Type: ["string","null"] |
| / |
Active or Resolved at the newest reading Type: string |
| / |
the impacted services Type: array |
| / |
Type: string |
| / |
the impact start, ISO 8601 in UTC Type: string |
| / |
the last update, ISO 8601 in UTC Type: ["string","null"] |
| / |
the certificate order's renewal state at the newest reading; null where none exists Type: ["object","null"] Required fields: ["name","status","auto_renew","days_to_expiry","expires","next_renewal","last_issued","read_at"] |
| / |
the order's name Type: string |
| / |
the order's status as the provider names it Type: ["string","null"] |
| / |
whether the order renews itself Type: ["boolean","null"] |
| / |
whole days from the reading to the order's expiry Type: ["number","null"] |
| / |
the expiry, ISO 8601 in UTC Type: ["string","null"] |
| / |
the next automatic renewal, ISO 8601 in UTC Type: ["string","null"] |
| / |
the last issuance, ISO 8601 in UTC Type: ["string","null"] |
| / |
the instant of the reading, ISO 8601 in UTC Type: string |
| / |
the newest pass's failed reads, each read:message, from its pass_runs detail; empty where every read answered Type: array |
| / |
Type: string |
| / |
every status setting as the status record stores it (PLD-L0-76), one row per served value in the served list's order. It is the one read of a status setting that writes nothing, where `set_status_setting` writes the row it answers. Type: object Required fields: ["rows"] Additional properties: false |
| / |
Type: array |
| / |
Type: object Required fields: ["name","value","source","stored_value","set_at","set_by"] Additional properties: false |
| / |
the served value's name Type: string Allowed values: ["probe_hostname","probe_path","samples_to_open","samples_to_close","probe_timeout_ms","stale_minutes","certificate_floor_days","error_counter_per_day","schedule_platform_outcomes_per_hour","mark_redeploy_concurrency","console_live_tail","unlimited_allowance_daily_signal_units","deploy_code_seconds","token_code_seconds"] |
| / |
the value in force: the stored row's where it is admitted, the coded default otherwise Type: ["integer","string"] |
| / |
`stored` where an admitted stored row sets the value; `default` where no row stands or the stored value is out of bounds Type: string Allowed values: ["stored","default"] |
| / |
the stored row's own value as written, an out-of-bounds one among them; null where no row stands Type: ["string","null"] |
| / |
the instant the stored row was written; null where no row stands Type: ["string","null"] |
| / |
the identity that wrote the stored row; null where no row stands Type: ["string","null"] |
Complete payload contract
{
"request": {
"type": "object",
"required": [],
"properties": {
"history_days": {
"type": "integer",
"minimum": 1,
"maximum": 365,
"description": "The window of the incidents section and of the changes section's last closed incident, in days before the read: 30 where none is given, 365 at most. A decimal string of the integer is admitted too, the query string's spelling, on GET and on POST alike; any other form refuses invalid_request naming the member."
},
"sections": {
"type": "array",
"items": {
"type": "string",
"enum": [
"now",
"components",
"changes",
"availability",
"plane_signals",
"background_work",
"capacity",
"watches",
"conditions",
"incidents",
"azure",
"settings"
]
},
"minItems": 1,
"description": "The sections to compose; every section where absent. A section not named is absent from the answer and its reads do not run. One string names one section, on GET and on POST alike; on GET the member repeated (`?sections=now§ions=components`) is the list. The value `read` is not a section name. An unknown name, an empty list, a comma-joined string, or a member of another type refuses invalid_request naming the member."
}
}
},
"response": {
"type": "object",
"required": [
"contract_version",
"read"
],
"properties": {
"contract_version": {
"const": 1
},
"read": {
"type": "object",
"required": [
"as_of",
"contract_version",
"build",
"history_days",
"sections_unavailable",
"summary_text"
],
"properties": {
"as_of": {
"type": "string",
"description": "the instant of the read, ISO 8601 in UTC"
},
"contract_version": {
"const": 1
},
"build": {
"type": "object",
"required": [
"source_commit",
"dirty",
"built_at"
],
"properties": {
"source_commit": {
"type": [
"string",
"null"
]
},
"dirty": {
"type": [
"boolean",
"null"
]
},
"built_at": {
"type": [
"string",
"null"
]
}
},
"description": "the control plane's own build stamp: the commit it was built from, whether the tree was dirty, and the build instant"
},
"history_days": {
"type": "integer",
"description": "the window applied"
},
"sections_unavailable": {
"type": "array",
"items": {
"type": "object",
"required": [
"section",
"detail"
],
"properties": {
"section": {
"type": "string",
"enum": [
"now",
"components",
"changes",
"availability",
"plane_signals",
"background_work",
"capacity",
"watches",
"conditions",
"incidents",
"azure",
"settings"
]
},
"detail": {
"type": "string"
}
}
},
"description": "each requested section whose composition failed, the section then absent. The detail is the fixed sentence `An unexpected error occurred; quote reference <reference> when reporting it.`, the control plane's own record holding the error under that reference and never the error's message (PLD-L0-80). It includes `azure` while the record holds no azure_* reading, the reason saying the hourly pass has not written one or naming the newest pass and its failed reads"
},
"summary_text": {
"type": "string",
"description": "the one-paragraph rendering: at most seventeen ASCII lines, one fact each. The lines hold the overall state as of the newest plane minute, the components not up, and the open incidents (five at most, one per row, then the count of the rest). They also hold the watched conditions open and failing (five subjects at most per state, then the count of the rest) and the overdue passes. They hold the nearest limits (three at most, one per row under their header), the hosting provider's line where that section composed, and the sections unavailable. It is the same text the status page's first section shows and a connected session prints for a \"show me the status\" ask"
}
},
"description": "always present: the read's own facts, composed last from what succeeded"
},
"now": {
"type": "object",
"required": [
"overall",
"as_of_minute",
"stale",
"open_incidents",
"worst",
"serving_build",
"last_change"
],
"properties": {
"overall": {
"type": "string",
"enum": [
"ok",
"degraded",
"down",
"unknown"
],
"description": "the platform's overall state from the components' standings"
},
"as_of_minute": {
"type": [
"string",
"null"
],
"description": "the newest plane.management sample's minute, ISO 8601 in UTC, or null"
},
"stale": {
"type": "boolean",
"description": "true where that minute is older than the stale bound before the read"
},
"open_incidents": {
"type": "array",
"items": {
"type": "object",
"description": "the row shape record_incident answers as `incident`: id, kind, state, opened_at, first_failure_at, closed_at, duration_ms, title, components, summary, cause, detection_source, author, updates, retirements"
},
"description": "the open incidents, newest opened first"
},
"worst": {
"type": [
"object",
"null"
],
"description": "the first component in the order down, degraded, unknown, by the earliest since: component, state, since; null where every component is up"
},
"serving_build": {
"type": [
"object",
"null"
],
"description": "the plane's serving build: source_commit and first_seen, the least minute of the newest run of samples carrying the pair (build, bundle_hash), a sample carrying neither member neither extending nor breaking the run and a change in either member starting a new one"
},
"last_change": {
"type": [
"string",
"null"
],
"description": "the newest since among the components, the last state change, ISO 8601 in UTC, or null"
}
},
"description": "the platform right now: the overall state, the newest plane minute and whether it is stale, the open incidents, the worst component, the serving build, and the last change"
},
"components": {
"type": "object",
"required": [
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"state",
"since",
"newest_minute",
"ready",
"status",
"latency_ms",
"build",
"bundle_hash",
"detail",
"consecutive_failed",
"omitted",
"timeline"
],
"properties": {
"name": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"up",
"degraded",
"down",
"unknown",
"retired"
]
},
"since": {
"type": [
"string",
"null"
],
"description": "the minute the current run began, ISO 8601 in UTC, or null"
},
"newest_minute": {
"type": [
"string",
"null"
],
"description": "the newest sample's minute, ISO 8601 in UTC, or null"
},
"ready": {
"type": [
"boolean",
"null"
],
"description": "the newest sample's readiness"
},
"status": {
"type": [
"integer",
"null"
],
"description": "the newest sample's HTTP status"
},
"latency_ms": {
"type": [
"integer",
"null"
],
"description": "the newest sample's latency"
},
"build": {
"type": [
"string",
"null"
],
"description": "the build the newest sample reported"
},
"bundle_hash": {
"type": [
"string",
"null"
],
"description": "the bundle hash the newest sample reported beside its build: the body's build.bundle_hash (MAPI-13), or for plane.management the process's own; null where the body carried none and on a failed sample"
},
"detail": {
"type": [
"string",
"null"
],
"description": "the newest sample's detail"
},
"consecutive_failed": {
"type": "integer",
"description": "the count of leading failed samples, newest first"
},
"omitted": {
"type": [
"string",
"null"
],
"description": "why the pass omits the component, where it does; such a component has state unknown and no sample"
},
"timeline": {
"type": "string",
"description": "sixty marks, one per minute, newest last: o for an ok sample, x for a failed one, ? for none"
}
}
},
"description": "one row per component the pass probes, plus every component the record has sampled that the current list no longer names, rendered retired"
}
},
"description": "every component's state, its newest sample, and its 60-minute timeline"
},
"changes": {
"type": "object",
"required": [
"builds",
"migrations",
"finished_actions",
"last_incident_closed"
],
"properties": {
"builds": {
"type": "array",
"items": {
"type": "object",
"description": "component, build, bundle_hash, and first_seen, the least minute of the newest run of samples carrying that pair (build, bundle_hash): a sample carrying neither member neither extends nor breaks the run, and a change in either member starts a new run"
},
"description": "each component's serving build with its bundle hash and when the pair was first seen"
},
"migrations": {
"type": "object",
"description": "control and logging, each the newest applied migration as name and applied_at, or null where the ledger is absent"
},
"finished_actions": {
"type": "array",
"items": {
"type": "object",
"description": "action, actor, requested_at, finished_at, and state"
},
"description": "the ten newest pending actions in a terminal state, newest finished first"
},
"last_incident_closed": {
"type": [
"object",
"null"
],
"description": "the newest closed incident within history_days, or null; the row shape record_incident answers as `incident`: id, kind, state, opened_at, first_failure_at, closed_at, duration_ms, title, components, summary, cause, detection_source, author, updates, retirements"
}
},
"description": "what changed recently: the serving builds, the newest migrations of the two databases, the last finished actions, and the last closed incident"
},
"availability": {
"type": "object",
"required": [
"objective",
"components"
],
"properties": {
"objective": {
"type": "object",
"description": "the availability objective: value (null while not yet set), the statement that owns it, and the detail saying where the value comes from"
},
"components": {
"type": "array",
"items": {
"type": "object",
"description": "component, first_minute, last_minute, and windows: one entry per window with window, minutes_considered, ok_minutes, failed_minutes, unknown_minutes, figure (null with the reason where no minute was measured), reason, and partial"
},
"description": "each component's availability over the four windows, counted from the stored samples and day rows"
}
},
"description": "the availability figures per component and window beside the objective"
},
"plane_signals": {
"type": "object",
"required": [
"routes",
"pools",
"schedule_tick",
"realm"
],
"properties": {
"routes": {
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"last_hour",
"last_24h"
],
"properties": {
"last_hour": {
"type": "object",
"description": "the counters of one window: requests, status_5xx, latency (le_50ms, le_200ms, le_1000ms, gt_1000ms), and mean_ms (ms_total / requests, null at zero requests)"
},
"last_24h": {
"type": "object",
"description": "the counters of one window: requests, status_5xx, latency (le_50ms, le_200ms, le_1000ms, gt_1000ms), and mean_ms (ms_total / requests, null at zero requests)"
}
}
},
"description": "keyed by route class: the requests, the 5xx count, the latency bands, and the mean over two bucket-aligned windows. The windows are last_hour, the current UTC hour's bucket so far, and last_24h, every hour bucket from the one holding as_of − 24h through the current hour's (25 at most)"
},
"pools": {
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"last_hour",
"last_24h"
],
"properties": {
"last_hour": {
"type": "object",
"description": "the counters of one window: waiting_seconds, saturated_seconds, and failover_retries"
},
"last_24h": {
"type": "object",
"description": "the counters of one window: waiting_seconds, saturated_seconds, and failover_retries"
}
}
},
"description": "keyed by pool name: the waiting seconds, the saturated seconds, and the failover retries over two bucket-aligned windows. The windows are last_hour, the current UTC hour's bucket so far, and last_24h, every hour bucket from the one holding as_of − 24h through the current hour's (25 at most)"
},
"schedule_tick": {
"type": "object",
"required": [
"last_hour",
"last_24h"
],
"properties": {
"last_hour": {
"type": "integer"
},
"last_24h": {
"type": "integer"
}
}
},
"realm": {
"type": "object",
"description": "reissues and reissue_refusals, each over two bucket-aligned windows: last_hour the current UTC hour's bucket so far, last_24h every hour bucket from the one holding as_of − 24h through the current hour's (25 at most)"
}
},
"description": "the control plane's own counters over two bucket-aligned windows: last_hour the current UTC hour's bucket so far, last_24h every hour bucket from the one holding as_of − 24h through the current hour's (25 at most). They are composed from the same store read read_control_plane_counters makes"
},
"background_work": {
"type": "object",
"required": [
"passes",
"executing",
"deploying",
"schedule_runs_running",
"schedule_runs_24h"
],
"properties": {
"passes": {
"type": "array",
"items": {
"type": "object",
"description": "pass, interval_ms (null where the pass has no interval), last_ran and last_failed (each a pass run — pass, replica, started_at, ended_at, outcome, detail — or null). It also carries stale, true where the last run is older than twice the interval, or where the pass has never run and the record began longer ago than that (its first migration; PLD-L0-76)"
},
"description": "every background pass with its last run and whether it is overdue"
},
"executing": {
"type": "array",
"items": {
"type": "object",
"description": "id, action, actor, and executing_at"
},
"description": "the pending actions in state executing, oldest first"
},
"deploying": {
"type": "array",
"items": {
"type": "object",
"description": "application, environment, version, and heartbeat_at"
},
"description": "every version row still deploying, oldest heartbeat first"
},
"schedule_runs_running": {
"type": "array",
"items": {
"type": "object",
"description": "application, environment, schedule, and started_at"
},
"description": "the schedule runs in flight, oldest first"
},
"schedule_runs_24h": {
"type": "object",
"additionalProperties": {
"type": "integer"
},
"description": "the count of schedule runs per outcome due in the last 24 hours"
}
},
"description": "the background passes and the backlogs: executing actions, deploying versions, and schedule runs"
},
"capacity": {
"type": "object",
"required": [
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"kind",
"subject",
"read_at",
"value",
"ceiling",
"headroom_percent",
"flagged",
"growth_per_day",
"days_to_exhaustion",
"reason",
"detail"
],
"properties": {
"kind": {
"type": "string",
"description": "the reading kind: placements_cell, placements_group, awake_group, server_databases, server_storage_bytes, server_backends, applications, accounts, control_db_bytes, logging_db_bytes, certificate_days, log_ingestion_gb, cost_month_to_date, email_sends_hour, plane_pools, or azure_quota"
},
"subject": {
"type": "string",
"description": "the cell, group, server, pool, hostname, or the one subject of a platform-wide kind"
},
"read_at": {
"type": [
"string",
"null"
],
"description": "the instant the value was read: the read itself for a live count, the newest stored reading otherwise, ISO 8601 in UTC, or null"
},
"value": {
"type": [
"number",
"null"
],
"description": "the reading; null where no reading exists yet"
},
"ceiling": {
"type": [
"number",
"null"
],
"description": "the bound the value is measured against: a registry nominal capacity, a server bound, a storage setting, the ingestion cap, or the email ceiling; null where unknown"
},
"headroom_percent": {
"type": [
"number",
"null"
],
"description": "100 × (1 − value / ceiling); null where either is unknown"
},
"flagged": {
"type": "boolean",
"description": "true where the used fraction is at or above the headroom flag"
},
"growth_per_day": {
"type": [
"number",
"null"
],
"description": "the least-squares slope over the readings of the last eight days where at least seven readings on distinct days exist and the slope is positive; null otherwise"
},
"days_to_exhaustion": {
"type": [
"number",
"null"
],
"description": "(ceiling − value) / growth_per_day where both are known; null otherwise"
},
"reason": {
"type": [
"string",
"null"
],
"description": "why a rate or a ceiling is absent: fewer than seven readings, zero or negative growth, ceiling unknown, no reading yet, or not read at this revision"
},
"detail": {
"type": [
"string",
"null"
],
"description": "The ceiling's provenance where it has one: the storage setting's last apply (autogrow can raise the live value between applies) or the setting's absence for a database size row, the pool max over the replicas for a plane_pools row. For the accounts row, `open_sign_ups=<count>`, the builder realm's open sign-up count its creation ceiling reads; null otherwise."
}
}
},
"description": "one row per reading kind and subject, with its ceiling, headroom, and rate"
}
},
"description": "the capacity rows: each reading against its ceiling, with the headroom, the flag, and the days to exhaustion where a rate can be read"
},
"watches": {
"type": "object",
"required": [
"certificates",
"log_ingestion",
"cost",
"email_sends",
"release_drift"
],
"properties": {
"certificates": {
"type": "array",
"items": {
"type": "object",
"required": [
"subject",
"read_at",
"days_to_expiry",
"reason"
],
"properties": {
"subject": {
"type": "string",
"description": "the certificate hostname"
},
"read_at": {
"type": [
"string",
"null"
],
"description": "the instant of the newest certificate_days reading, ISO 8601 in UTC, or null where none exists"
},
"days_to_expiry": {
"type": [
"number",
"null"
],
"description": "the newest certificate_days reading's value, the days until the certificate expires; null where no reading exists"
},
"reason": {
"type": [
"string",
"null"
],
"description": "why the value is absent: no reading yet; or `stale` where the newest reading is older than twice the daily pass's interval, the value shown being that reading; null otherwise"
}
}
},
"description": "one row per certificate hostname, from the newest certificate_days reading"
},
"log_ingestion": {
"type": "object",
"required": [
"read_at",
"ingested_gb",
"daily_cap_gb",
"headroom_percent",
"reset_at",
"reason"
],
"properties": {
"read_at": {
"type": [
"string",
"null"
],
"description": "the instant of the newest log_ingestion_gb reading, ISO 8601 in UTC, or null where none exists"
},
"ingested_gb": {
"type": [
"number",
"null"
],
"description": "the newest log_ingestion_gb reading's value, the gigabytes ingested in the workspace's current day; null where no reading exists"
},
"daily_cap_gb": {
"type": [
"number",
"null"
],
"description": "that reading's bound, the daily cap; null where unknown"
},
"headroom_percent": {
"type": [
"number",
"null"
],
"description": "100 × (1 − ingested_gb / daily_cap_gb); null where either is unknown"
},
"reset_at": {
"type": [
"string",
"null"
],
"description": "the instant the daily cap resets, from the reading's detail, ISO 8601 in UTC, or null where the reading carries none"
},
"reason": {
"type": [
"string",
"null"
],
"description": "why the value is absent: no reading yet; or `stale` where the newest reading is older than twice the daily pass's interval, the value shown being that reading; null otherwise"
}
},
"description": "the log ingestion against its daily cap, from the newest log_ingestion_gb reading"
},
"cost": {
"type": "object",
"required": [
"month_to_date",
"read_at",
"projected_month_end",
"reason"
],
"properties": {
"month_to_date": {
"type": [
"number",
"null"
],
"description": "the newest cost_month_to_date reading of the calendar month; null where none exists"
},
"read_at": {
"type": [
"string",
"null"
],
"description": "the instant of the newest cost_month_to_date reading, ISO 8601 in UTC, or null where none exists"
},
"projected_month_end": {
"type": [
"number",
"null"
],
"description": "a linear projection to the month's end, the burn between the month's first reading in the window and the newest carried forward; null where fewer than two readings exist or the newest reading is stale"
},
"reason": {
"type": [
"string",
"null"
],
"description": "why the value is absent: no reading yet; `stale` where the newest reading is older than twice the daily pass's interval, the value shown being that reading and the projection withheld; or fewer than two readings this month for the projection; null otherwise"
}
},
"description": "the month-to-date cost and its projection to the month's end"
},
"email_sends": {
"type": "object",
"required": [
"read_at",
"sends",
"bound",
"headroom_percent",
"reason"
],
"properties": {
"read_at": {
"type": [
"string",
"null"
],
"description": "the instant of the newest email_sends_hour reading, ISO 8601 in UTC, or null where none exists"
},
"sends": {
"type": [
"number",
"null"
],
"description": "the newest email_sends_hour reading's value, the sends in the hour; null where no reading exists"
},
"bound": {
"type": [
"number",
"null"
],
"description": "that reading's bound, the hourly ceiling; null where unknown"
},
"headroom_percent": {
"type": [
"number",
"null"
],
"description": "100 × (1 − sends / bound); null where either is unknown"
},
"reason": {
"type": [
"string",
"null"
],
"description": "why the value is absent: no reading yet; or `stale` where the newest reading is older than twice the daily pass's interval, the value shown being that reading; null otherwise"
}
},
"description": "the email sends against the hourly ceiling, from the newest email_sends_hour reading"
},
"release_drift": {
"type": "object",
"required": [
"drifted",
"components"
],
"properties": {
"drifted": {
"type": "boolean",
"description": "true where components is not empty"
},
"components": {
"type": "array",
"items": {
"type": "object",
"required": [
"component",
"build"
],
"properties": {
"component": {
"type": "string",
"description": "the component name"
},
"build": {
"type": "string",
"description": "the build its newest sample reports"
}
}
},
"description": "each standing component (neither retired nor omitted) that runs the plane image — plane.management, plane.accounts, plane.internal, edge.management, edge.gateways, and `shard.<id>.gateway_public` and `shard.<id>.gateway_private` for every routing tier — whose newest sample reports a build other than the plane's own, with that build. The router and the egress seat are outside the watch, their bundles built at their own roll commits. Empty where the plane's own build is unknown"
}
},
"description": "the release drift: whether any standing component that runs the plane image serves a build other than the plane's own, and which"
}
},
"description": "the watches: the certificates, the log ingestion, the cost, the email sends, and the release drift"
},
"conditions": {
"type": "object",
"required": [
"evaluated_at",
"reason",
"rows"
],
"properties": {
"evaluated_at": {
"type": [
"string",
"null"
],
"description": "the instant of the newest conditions-pass run that held its claim and ran; null with `reason` where no such run stands"
},
"reason": {
"type": [
"string",
"null"
],
"description": "why `evaluated_at` is null; null where it is present"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"subject",
"state",
"since",
"detail",
"incident"
],
"properties": {
"subject": {
"type": "string",
"description": "the watched subject, `condition.<name>` or `condition.<name>.<segment>`"
},
"state": {
"type": "string",
"enum": [
"clear",
"failing",
"open",
"suppressed"
],
"description": "`open` where the row names an open incident, `suppressed` where a planned incident naming the subject or naming no component suppresses a failing evaluation, `failing` where the failing run is above zero with no incident, `clear` otherwise"
},
"since": {
"type": [
"string",
"null"
],
"description": "the current failing run's first instant, or the last evaluation where the subject is not failing"
},
"detail": {
"type": [
"string",
"null"
],
"description": "names, classes, and counts, never an error's message"
},
"incident": {
"type": [
"string",
"null"
],
"description": "the incident the row names, open or hand-closed; null where it names none"
}
}
},
"description": "one row per subject the record holds, in subject order"
}
},
"description": "the watched conditions (the incident record's condition source): the newest run that held its claim, and one row per subject with its state, the fact the operator acts on"
},
"incidents": {
"type": "object",
"required": [
"open",
"history"
],
"properties": {
"open": {
"type": "array",
"items": {
"type": "object",
"description": "the row shape record_incident answers as `incident`: id, kind, state, opened_at, first_failure_at, closed_at, duration_ms, title, components, summary, cause, detection_source, author, updates, retirements"
},
"description": "the open incidents, newest opened first"
},
"history": {
"type": "array",
"items": {
"type": "object",
"description": "the row shape record_incident answers as `incident`: id, kind, state, opened_at, first_failure_at, closed_at, duration_ms, title, components, summary, cause, detection_source, author, updates, retirements"
},
"description": "the incidents opened within history_days that are not open, newest opened first"
}
},
"description": "the incident record: the open incidents and the history within the window"
},
"azure": {
"type": "object",
"description": "what the hosting provider itself measures, read by the hourly provider readings pass under the status-reader role and stored as platform_readings (PLD-L0-76). The section is composed from those readings alone. It is absent while no azure_* reading exists, the section then named in sections_unavailable with the reason. A reading is never made at read time",
"required": [
"read_at",
"alerts",
"origin_health",
"servers",
"resource_health",
"service_issues",
"certificate_order",
"failed_reads"
],
"properties": {
"read_at": {
"type": [
"string",
"null"
],
"description": "the newest pass's start instant, ISO 8601 in UTC; the newest reading's instant where no pass row stands"
},
"alerts": {
"type": "object",
"required": [
"since",
"rows"
],
"properties": {
"since": {
"type": "string",
"description": "the start of the window the rows cover, 30 days before the read, ISO 8601 in UTC"
},
"rows": {
"type": "array",
"description": "every alert instance that started in the window, newest first",
"items": {
"type": "object",
"required": [
"id",
"rule",
"target",
"severity",
"condition",
"started",
"resolved",
"description",
"declared"
],
"properties": {
"id": {
"type": "string",
"description": "the alert's name as the provider reports it, the rule's name; the row's key is that name with the instance's start"
},
"rule": {
"type": "string",
"description": "the rule's name, the last segment of its resource id"
},
"target": {
"type": [
"string",
"null"
],
"description": "the target resource's name"
},
"severity": {
"type": [
"string",
"null"
],
"description": "the severity as the provider names it, Sev0 to Sev4"
},
"condition": {
"type": "string",
"enum": [
"Fired",
"Resolved"
],
"description": "the monitor condition at the newest reading"
},
"started": {
"type": "string",
"description": "the instance start, ISO 8601 in UTC"
},
"resolved": {
"type": [
"string",
"null"
],
"description": "the resolution instant where resolved, ISO 8601 in UTC"
},
"description": {
"type": [
"string",
"null"
],
"description": "the rule's description as the instance carries it, at most 200 characters"
},
"declared": {
"type": "boolean",
"description": "whether the rule's key is one the five rule-declaring templates declare"
}
}
}
}
}
},
"origin_health": {
"type": "object",
"required": [
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"origin_group",
"hour",
"minimum_percent",
"mean_percent",
"samples"
],
"properties": {
"origin_group": {
"type": "string",
"description": "the edge profile's origin group"
},
"hour": {
"type": "string",
"description": "the start of the hour the reading covers, ISO 8601 in UTC"
},
"minimum_percent": {
"type": [
"number",
"null"
],
"description": "the hour's minimum OriginHealthPercentage"
},
"mean_percent": {
"type": [
"number",
"null"
],
"description": "the hour's mean OriginHealthPercentage"
},
"samples": {
"type": [
"number",
"null"
],
"description": "the minutes with a value in the hour"
}
}
},
"description": "the last 24 hours, by origin group then hour"
}
}
},
"servers": {
"type": "object",
"required": [
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"host",
"hour",
"down_minutes",
"samples",
"registry"
],
"properties": {
"host": {
"type": "string",
"description": "the flexible server's host name"
},
"hour": {
"type": "string",
"description": "the start of the hour the reading covers, ISO 8601 in UTC"
},
"down_minutes": {
"type": [
"number",
"null"
],
"description": "the minutes whose is_db_alive maximum was 0"
},
"samples": {
"type": [
"number",
"null"
],
"description": "the minutes with a value in the hour"
},
"registry": {
"type": "boolean",
"description": "true for a host the registry servers rows name, false for a control-tier host"
}
}
},
"description": "the last 24 hours, by host then hour"
}
}
},
"resource_health": {
"type": "object",
"required": [
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"resource",
"state",
"summary",
"read_at"
],
"properties": {
"resource": {
"type": "string",
"description": "the resource below its group: group/provider/type/name"
},
"state": {
"type": "string",
"description": "Resource Health's availability state: Available, Unavailable, Degraded, or Unknown"
},
"summary": {
"type": [
"string",
"null"
],
"description": "Resource Health's summary, at most 200 characters"
},
"read_at": {
"type": "string",
"description": "the instant of the reading, ISO 8601 in UTC"
}
}
},
"description": "the newest reading per resource of the plane, routing tier, and cell groups"
}
}
},
"service_issues": {
"type": "object",
"required": [
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"level",
"status",
"services",
"started",
"updated"
],
"properties": {
"id": {
"type": "string",
"description": "the event's tracking id"
},
"title": {
"type": [
"string",
"null"
],
"description": "the event's title"
},
"level": {
"type": [
"string",
"null"
],
"description": "the event's level"
},
"status": {
"type": "string",
"description": "Active or Resolved at the newest reading"
},
"services": {
"type": "array",
"items": {
"type": "string"
},
"description": "the impacted services"
},
"started": {
"type": "string",
"description": "the impact start, ISO 8601 in UTC"
},
"updated": {
"type": [
"string",
"null"
],
"description": "the last update, ISO 8601 in UTC"
}
}
},
"description": "the service issues read in the last 30 days that name the region or are global and are Active or started or last updated within the last three days, newest first"
}
}
},
"certificate_order": {
"type": [
"object",
"null"
],
"description": "the certificate order's renewal state at the newest reading; null where none exists",
"required": [
"name",
"status",
"auto_renew",
"days_to_expiry",
"expires",
"next_renewal",
"last_issued",
"read_at"
],
"properties": {
"name": {
"type": "string",
"description": "the order's name"
},
"status": {
"type": [
"string",
"null"
],
"description": "the order's status as the provider names it"
},
"auto_renew": {
"type": [
"boolean",
"null"
],
"description": "whether the order renews itself"
},
"days_to_expiry": {
"type": [
"number",
"null"
],
"description": "whole days from the reading to the order's expiry"
},
"expires": {
"type": [
"string",
"null"
],
"description": "the expiry, ISO 8601 in UTC"
},
"next_renewal": {
"type": [
"string",
"null"
],
"description": "the next automatic renewal, ISO 8601 in UTC"
},
"last_issued": {
"type": [
"string",
"null"
],
"description": "the last issuance, ISO 8601 in UTC"
},
"read_at": {
"type": "string",
"description": "the instant of the reading, ISO 8601 in UTC"
}
}
},
"failed_reads": {
"type": "array",
"items": {
"type": "string"
},
"description": "the newest pass's failed reads, each read:message, from its pass_runs detail; empty where every read answered"
}
}
},
"settings": {
"type": "object",
"required": [
"rows"
],
"additionalProperties": false,
"description": "every status setting as the status record stores it (PLD-L0-76), one row per served value in the served list's order. It is the one read of a status setting that writes nothing, where `set_status_setting` writes the row it answers.",
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value",
"source",
"stored_value",
"set_at",
"set_by"
],
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"enum": [
"probe_hostname",
"probe_path",
"samples_to_open",
"samples_to_close",
"probe_timeout_ms",
"stale_minutes",
"certificate_floor_days",
"error_counter_per_day",
"schedule_platform_outcomes_per_hour",
"mark_redeploy_concurrency",
"console_live_tail",
"unlimited_allowance_daily_signal_units",
"deploy_code_seconds",
"token_code_seconds"
],
"description": "the served value's name"
},
"value": {
"type": [
"integer",
"string"
],
"description": "the value in force: the stored row's where it is admitted, the coded default otherwise"
},
"source": {
"type": "string",
"enum": [
"stored",
"default"
],
"description": "`stored` where an admitted stored row sets the value; `default` where no row stands or the stored value is out of bounds"
},
"stored_value": {
"type": [
"string",
"null"
],
"description": "the stored row's own value as written, an out-of-bounds one among them; null where no row stands"
},
"set_at": {
"type": [
"string",
"null"
],
"description": "the instant the stored row was written; null where no row stands"
},
"set_by": {
"type": [
"string",
"null"
],
"description": "the identity that wrote the stored row; null where no row stands"
}
}
}
}
}
}
},
"additionalProperties": false,
"description": "The status document: `read` always, then each requested section that composed, each absent where not requested or where its read failed (then named in read.sections_unavailable). Every instant is ISO 8601 in UTC."
}
}
Shared contracts
- Refusals: every refusal, by surface, with its cause and its remedy
- schemas/wire_error.schema.json
- schemas/wire_errors.json
- schemas/action_payloads.json (includes shared shapes)
- management_api_contract.md