@leaflow/sdk 0.0.0-dev.35.g30ba751 → 0.0.0-dev.353.g74313e0

package/dist/monitoring/v1/generated/schemas.zod.d.ts

@@ -0,0 +1,815 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Monitoring API
+ * Monitoring for your own project: enroll machines, read metrics, work through incidents, schedule maintenance windows, and set availability targets.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * ## Two distinctions worth keeping straight
+ *
+ * - **Disabling is not deleting.** `POST /servers/{id}/disable` is reversible and preserves all history. `DELETE /servers/{id}` also removes the monitored host, its history and every incident recorded against it, and cannot be undone.
+ * - **Recovery is not closure.** `incident_status` reports whether monitoring considers the problem recovered; `closed_at` reports whether someone has finished handling it. An incident that has not recovered may still be closed as an accepted risk.
+ *
+ * ## The PSK is returned once
+ *
+ * Enrollment and rotation responses include `tls_psk`. No other endpoint will return it again, so store it immediately. If it is lost, rotate once more — at the cost of updating the agent configuration on the monitored machine.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+/**
+ * `incident_status` reports whether monitoring considers the problem recovered; `closed` reports whether someone has finished handling it. The two are independent and can be filtered separately.
+ * @summary List incidents
+ */
+export declare const listIncidentsQueryLimitDefault = 50;
+export declare const listIncidentsQueryLimitMax = 200;
+export declare const listIncidentsQueryOffsetDefault = 0;
+export declare const listIncidentsQueryOffsetMin = 0;
+export declare const listIncidentsQueryOffsetMax = 10000;
+export declare const listIncidentsQueryKeywordMax = 255;
+export declare const ListIncidentsQueryParams: zod.ZodObject<{
+    limit: zod.ZodDefault<zod.ZodInt>;
+    offset: zod.ZodDefault<zod.ZodInt>;
+    server_id: zod.ZodOptional<zod.ZodString>;
+    web_check_id: zod.ZodOptional<zod.ZodString>;
+    incident_status: zod.ZodOptional<zod.ZodEnum<{
+        PROBLEM: "PROBLEM";
+        RESOLVED: "RESOLVED";
+    }>>;
+    min_severity: zod.ZodOptional<zod.ZodEnum<{
+        NOT_CLASSIFIED: "NOT_CLASSIFIED";
+        INFORMATION: "INFORMATION";
+        WARNING: "WARNING";
+        AVERAGE: "AVERAGE";
+        HIGH: "HIGH";
+        DISASTER: "DISASTER";
+    }>>;
+    started_after: zod.ZodOptional<zod.z.ZodISODateTime>;
+    started_before: zod.ZodOptional<zod.z.ZodISODateTime>;
+    active_from: zod.ZodOptional<zod.z.ZodISODateTime>;
+    active_to: zod.ZodOptional<zod.z.ZodISODateTime>;
+    tag: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodString>>>;
+    assignee_user_id: zod.ZodOptional<zod.ZodString>;
+    closed: zod.ZodOptional<zod.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>>;
+    acknowledged: zod.ZodOptional<zod.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>>;
+    unassigned: zod.ZodOptional<zod.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>>;
+    keyword: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get an incident
+ */
+export declare const GetIncidentParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * The incident is also marked as acknowledged in the monitoring system, so that other channels can see it already has an owner.
+ * @summary Acknowledge an incident
+ */
+export declare const AcknowledgeIncidentParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const AcknowledgeIncidentBody: zod.ZodObject<{
+    message: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * Leave `assignee_user_id` empty to clear the assignment.
+ *
+ * **Project membership of the assignee is not verified.** Any user identifier is accepted and recorded as given.
+ * @summary Assign an incident, or clear its assignee
+ */
+export declare const AssignIncidentParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const AssignIncidentBody: zod.ZodObject<{
+    assignee_display_name: zod.ZodOptional<zod.ZodString>;
+    assignee_user_id: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * Closing records **that the handling process is finished on this platform**; it does not change the state of the incident itself. An incident that has not recovered may still be closed as an accepted risk, and remains unrecovered in the monitoring system.
+ * @summary Close an incident
+ */
+export declare const CloseIncidentParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const CloseIncidentBody: zod.ZodObject<{
+    message: zod.ZodOptional<zod.ZodString>;
+    reason: zod.ZodEnum<{
+        RECOVERED: "RECOVERED";
+        FIXED: "FIXED";
+        FALSE_POSITIVE: "FALSE_POSITIVE";
+        DUPLICATE: "DUPLICATE";
+        NO_ACTION_REQUIRED: "NO_ACTION_REQUIRED";
+        ACCEPTED_RISK: "ACCEPTED_RISK";
+        OTHER: "OTHER";
+    }>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Add a note to the timeline
+ */
+export declare const AddIncidentCommentParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const AddIncidentCommentBody: zod.ZodObject<{
+    message: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * You follow **yourself**: the caller is the user added to or removed from the follower list.
+ * @summary Follow an incident, or stop following it
+ */
+export declare const SetIncidentFollowingParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const SetIncidentFollowingBody: zod.ZodObject<{
+    following: zod.ZodBoolean;
+}, zod.z.core.$strict>;
+/**
+ * @summary Reopen a closed incident
+ */
+export declare const ReopenIncidentParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Cursor paging rather than offset paging: the timeline is append-only, and offset paging would skip or repeat entries whenever a new one is written.
+ *
+ * Omit cursor on the first page. An empty next_cursor means there is no following page; do not send an empty cursor.
+ * @summary List the timeline of an incident
+ */
+export declare const ListIncidentTimelineParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const listIncidentTimelineQueryLimitDefault = 50;
+export declare const listIncidentTimelineQueryLimitMax = 200;
+export declare const listIncidentTimelineQueryCursorMax = 1024;
+export declare const ListIncidentTimelineQueryParams: zod.ZodObject<{
+    limit: zod.ZodDefault<zod.ZodInt>;
+    cursor: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a maintenance window
+ */
+export declare const GetMaintenanceWindowParams: zod.ZodObject<{
+    windowId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * **Create or replace**: extending a window that is already running means calling this endpoint again with the same id.
+ *
+ * While the window is open, problems on these machines do not alert and do not count against SLA availability. Leave `server_ids` empty to cover the entire project, including machines enrolled after the window opens.
+ * @summary Create a maintenance window, or replace it by the same id
+ */
+export declare const PutMaintenanceWindowParams: zod.ZodObject<{
+    windowId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const PutMaintenanceWindowBody: zod.ZodObject<{
+    active_since: zod.z.ZodISODateTime;
+    active_till: zod.z.ZodISODateTime;
+    description: zod.ZodOptional<zod.ZodString>;
+    name: zod.ZodString;
+    period: zod.ZodObject<{
+        duration_seconds: zod.ZodOptional<zod.ZodInt>;
+        every: zod.ZodOptional<zod.ZodInt>;
+        kind: zod.ZodEnum<{
+            ONCE: "ONCE";
+            DAILY: "DAILY";
+            WEEKLY: "WEEKLY";
+        }>;
+        start_time_seconds: zod.ZodOptional<zod.ZodInt>;
+        starts_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+        weekdays: zod.ZodOptional<zod.ZodInt>;
+    }, zod.z.core.$strict>;
+    server_ids: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodString>>>;
+    timezone: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * Alerting resumes immediately, even if the window has not yet expired.
+ * @summary Cancel a maintenance window
+ */
+export declare const DeleteMaintenanceWindowParams: zod.ZodObject<{
+    windowId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Items are returned exactly as collected, without filtering or renaming. Which of them count as important is for the caller to decide from the tags carried by each item.
+ * @summary List the monitoring items of a machine
+ */
+export declare const ListServerItemsParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const listServerItemsQueryKeywordMax = 255;
+export declare const ListServerItemsQueryParams: zod.ZodObject<{
+    keyword: zod.ZodOptional<zod.ZodString>;
+    tag: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodString>>>;
+}, zod.z.core.$strict>;
+/**
+ * `item_key` is matched **by prefix**. Keys discovered per partition or per interface carry parameters (`vfs.fs.size[/var,pused]`), so a single request for `vfs.fs.size` returns one series per mount point.
+ * @summary Get the time series of a monitoring item
+ */
+export declare const GetServerMetricParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const getServerMetricQueryMaxPointsMin = 0;
+export declare const GetServerMetricQueryParams: zod.ZodObject<{
+    item_key: zod.ZodOptional<zod.ZodString>;
+    item_id: zod.ZodOptional<zod.ZodString>;
+    from: zod.ZodOptional<zod.z.ZodISODateTime>;
+    to: zod.ZodOptional<zod.z.ZodISODateTime>;
+    max_points: zod.ZodOptional<zod.ZodInt>;
+    include_thresholds: zod.ZodOptional<zod.ZodBoolean>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Hardware and interfaces of a machine
+ */
+export declare const GetServerResourcesParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * @summary Current state of a machine
+ */
+export declare const GetServerSnapshotParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * @summary Machines ranked highest by a given metric
+ */
+export declare const listProjectTopItemsQueryLimitMin = 0;
+export declare const listProjectTopItemsQueryLimitMax = 100;
+export declare const ListProjectTopItemsQueryParams: zod.ZodObject<{
+    kind: zod.ZodEnum<{
+        CPU_UTILIZATION: "CPU_UTILIZATION";
+        MEMORY_UTILIZATION: "MEMORY_UTILIZATION";
+        ROOT_FILESYSTEM_USED: "ROOT_FILESYSTEM_USED";
+    }>;
+    limit: zod.ZodOptional<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * @summary List the machines in the project
+ */
+export declare const listServersQueryLimitDefault = 50;
+export declare const listServersQueryLimitMax = 200;
+export declare const listServersQueryOffsetDefault = 0;
+export declare const listServersQueryOffsetMin = 0;
+export declare const listServersQueryOffsetMax = 10000;
+export declare const listServersQueryKeywordMax = 255;
+export declare const ListServersQueryParams: zod.ZodObject<{
+    limit: zod.ZodDefault<zod.ZodInt>;
+    offset: zod.ZodDefault<zod.ZodInt>;
+    keyword: zod.ZodOptional<zod.ZodString>;
+    monitoring_status: zod.ZodOptional<zod.ZodEnum<{
+        ACTIVE: "ACTIVE";
+        PENDING: "PENDING";
+        FAILED: "FAILED";
+        DISABLED: "DISABLED";
+    }>>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get the enrollment state of a machine
+ */
+export declare const GetServerParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * **Repeated calls with the same server id are idempotent**: given identical parameters, the already-enrolled machine is returned and no duplicate host is created, so a failed enrollment is safe to retry.
+ *
+ * To change enrollment settings, use PATCH. This endpoint returns an error when the parameters differ, and does not update an existing configuration.
+ *
+ * A failed call leaves the machine recorded with `monitoring_status: FAILED`; the reason is reported in `last_error` via `GET /servers/{serverId}`.
+ *
+ * The `tls_psk` in the response is **returned only this once**; store it immediately. If it is lost, it must be rotated.
+ *
+ * It is also how collection is resumed after `/disable`. On a machine that already exists, **omitting `template_bindings` keeps the bindings it already has**; it does not fall back to the default of Linux alone, which would silently drop every other template together with its parameters. Secret parameters are likewise carried over — see `parameters` on the binding.
+ * @summary Enroll a machine into monitoring
+ */
+export declare const EnableServerMonitoringParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const EnableServerMonitoringBody: zod.ZodObject<{
+    address: zod.ZodString;
+    address_kind: zod.ZodEnum<{
+        ip: "ip";
+        dns: "dns";
+    }>;
+    agent_mode: zod.ZodOptional<zod.ZodEnum<{
+        ACTIVE: "ACTIVE";
+        PASSIVE: "PASSIVE";
+    }>>;
+    agent_port: zod.ZodOptional<zod.ZodInt>;
+    description: zod.ZodOptional<zod.ZodString>;
+    name: zod.ZodString;
+    template_bindings: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodObject<{
+        parameters: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+        template_key: zod.ZodEnum<{
+            LINUX: "LINUX";
+            SYSTEMD: "SYSTEMD";
+            DOCKER: "DOCKER";
+            ICMP_PING: "ICMP_PING";
+            NGINX: "NGINX";
+            PHP_FPM: "PHP_FPM";
+            WEBSITE_CERTIFICATE: "WEBSITE_CERTIFICATE";
+            WINDOWS: "WINDOWS";
+            SMART: "SMART";
+            NVIDIA: "NVIDIA";
+            PROXMOX_VE: "PROXMOX_VE";
+        }>;
+    }, zod.z.core.$strict>>>>;
+}, zod.z.core.$strict>;
+/**
+ * Only the fields present in the request body are updated. `address` and `address_kind` must be supplied together: changing one without the other produces a contradictory configuration that is not reported as an error and shows up only as an agent that cannot connect.
+ * @summary Update the enrollment settings of a machine
+ */
+export declare const UpdateServerParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const UpdateServerBody: zod.ZodObject<{
+    address: zod.ZodOptional<zod.ZodString>;
+    address_kind: zod.ZodOptional<zod.ZodEnum<{
+        ip: "ip";
+        dns: "dns";
+    }>>;
+    agent_mode: zod.ZodOptional<zod.ZodEnum<{
+        ACTIVE: "ACTIVE";
+        PASSIVE: "PASSIVE";
+    }>>;
+    agent_port: zod.ZodOptional<zod.ZodInt>;
+    description: zod.ZodOptional<zod.ZodString>;
+    name: zod.ZodOptional<zod.ZodString>;
+    template_bindings: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        parameters: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+        template_key: zod.ZodEnum<{
+            LINUX: "LINUX";
+            SYSTEMD: "SYSTEMD";
+            DOCKER: "DOCKER";
+            ICMP_PING: "ICMP_PING";
+            NGINX: "NGINX";
+            PHP_FPM: "PHP_FPM";
+            WEBSITE_CERTIFICATE: "WEBSITE_CERTIFICATE";
+            WINDOWS: "WINDOWS";
+            SMART: "SMART";
+            NVIDIA: "NVIDIA";
+            PROXMOX_VE: "PROXMOX_VE";
+        }>;
+    }, zod.z.core.$strict>>>;
+}, zod.z.core.$strict>;
+/**
+ * **Irreversible**: the monitored host, its history and every incident recorded against this machine are removed together. To stop collection temporarily, use `/disable` instead.
+ * @summary Delete a machine
+ */
+export declare const DeleteServerParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Reversible: the monitored host is retained, only collection stops, and history is unaffected. Enrolling again resumes collection. To remove the history as well, use DELETE.
+ * @summary Stop monitoring a machine
+ */
+export declare const DisableServerMonitoringParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * The agent configuration must be updated to match, otherwise the machine loses contact immediately. The new key is likewise **returned in clear text only in this response**.
+ * @summary Rotate the agent PSK
+ */
+export declare const RotateAgentPskParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a web check
+ */
+export declare const GetWebCheckParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+    checkId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * **Create or replace**: to modify a check, call this endpoint again with the same id. There is no need to determine first whether it already exists.
+ * @summary Create a web check, or replace it by the same id
+ */
+export declare const PutWebCheckParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+    checkId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const PutWebCheckBody: zod.ZodObject<{
+    interval_seconds: zod.ZodOptional<zod.ZodInt>;
+    response_time_threshold_seconds: zod.ZodOptional<zod.ZodInt>;
+    retries: zod.ZodOptional<zod.ZodInt>;
+    steps: zod.ZodNullable<zod.ZodArray<zod.ZodObject<{
+        expected_status_codes: zod.ZodOptional<zod.ZodString>;
+        follow_redirects: zod.ZodOptional<zod.ZodBoolean>;
+        name: zod.ZodString;
+        required_pattern: zod.ZodOptional<zod.ZodString>;
+        url: zod.ZodString;
+    }, zod.z.core.$strict>>>;
+    timeout_seconds: zod.ZodOptional<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * The corresponding check task and trigger are removed from the monitoring system as well, so no permanently unrecoverable alert is left behind.
+ * @summary Delete a web check
+ */
+export declare const DeleteWebCheckParams: zod.ZodObject<{
+    serverId: zod.ZodUUID;
+    checkId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * @summary List web checks
+ */
+export declare const ListWebChecksQueryParams: zod.ZodObject<{
+    server_id: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * SLI is what was measured; SLO is what was promised — this endpoint returns the former.
+ *
+ * The row with an empty `server_id` covers the project as a whole.
+ * @summary Get measured availability
+ */
+export declare const getSliReportQueryPeriodsMin = 0;
+export declare const getSliReportQueryPeriodsMax = 100;
+export declare const GetSliReportQueryParams: zod.ZodObject<{
+    from: zod.ZodOptional<zod.z.ZodISODateTime>;
+    to: zod.ZodOptional<zod.z.ZodISODateTime>;
+    periods: zod.ZodOptional<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * One SLO per project, **create or replace**.
+ *
+ * `min_severity` must be chosen explicitly: it defines what counts as unavailable, which is half of what the target means.
+ * @summary Set the availability target of this project, or change it
+ */
+export declare const PutSloBody: zod.ZodObject<{
+    effective_from: zod.ZodOptional<zod.z.ZodISODateTime>;
+    min_severity: zod.ZodEnum<{
+        INFORMATION: "INFORMATION";
+        WARNING: "WARNING";
+        AVERAGE: "AVERAGE";
+        HIGH: "HIGH";
+        DISASTER: "DISASTER";
+        ANY: "ANY";
+    }>;
+    name: zod.ZodString;
+    period: zod.ZodOptional<zod.ZodEnum<{
+        DAILY: "DAILY";
+        WEEKLY: "WEEKLY";
+        MONTHLY: "MONTHLY";
+        QUARTERLY: "QUARTERLY";
+        ANNUALLY: "ANNUALLY";
+    }>>;
+    schedule: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodObject<{
+        end_time_seconds: zod.ZodOptional<zod.ZodInt>;
+        start_time_seconds: zod.ZodOptional<zod.ZodInt>;
+        weekdays: zod.ZodInt;
+    }, zod.z.core.$strict>>>>;
+    slo_id: zod.ZodUUID;
+    slo_percent: zod.ZodNumber;
+    timezone: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * **Create or replace**: changing the title, switching the domain, publishing and unpublishing are all done by sending the complete configuration again.
+ *
+ * While `published` is false the public address returns 404, including any custom domain already bound. A newly created page is unpublished by default, so that a page still being configured has no address that opens.
+ *
+ * `slug` and `custom_domain` are **globally unique**; a value already taken returns 409.
+ * @summary Create the status page, or replace its configuration
+ */
+export declare const PutStatusPageBody: zod.ZodObject<{
+    brand_color: zod.ZodOptional<zod.ZodString>;
+    custom_domain: zod.ZodOptional<zod.ZodString>;
+    footer_text: zod.ZodOptional<zod.ZodString>;
+    headline: zod.ZodOptional<zod.ZodString>;
+    logo_url: zod.ZodOptional<zod.ZodString>;
+    name: zod.ZodString;
+    published: zod.ZodDefault<zod.ZodBoolean>;
+    search_engine_index: zod.ZodDefault<zod.ZodBoolean>;
+    slug: zod.ZodOptional<zod.ZodString>;
+    support_url: zod.ZodOptional<zod.ZodString>;
+    theme: zod.ZodDefault<zod.ZodEnum<{
+        AUTO: "AUTO";
+        LIGHT: "LIGHT";
+        DARK: "DARK";
+    }>>;
+    timezone: zod.ZodOptional<zod.ZodString>;
+    uptime_days: zod.ZodDefault<zod.ZodInt>;
+    support_label: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * Submits the **entire** top-level order in one call rather than moving a single entry to a given position.
+ *
+ * The top level interleaves groups and ungrouped components, so the order is expressed as one list covering both.
+ *
+ * Each entry carries either `group_id` or `component_id`. Entries not listed are placed after those that are.
+ * @summary Set the order of the top level of the page
+ */
+export declare const PutStatusPageOrderBody: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        component_id: zod.ZodOptional<zod.ZodUUID>;
+        group_id: zod.ZodOptional<zod.ZodUUID>;
+    }, zod.z.core.$strict>>;
+}, zod.z.core.$strict>;
+/**
+ * A group is one level of collapsing applied to components on the page. There is exactly one level; groups cannot be nested.
+ * @summary Create a group
+ */
+export declare const CreateStatusPageGroupBody: zod.ZodObject<{
+    collapsed: zod.ZodDefault<zod.ZodBoolean>;
+    description: zod.ZodOptional<zod.ZodString>;
+    name: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * @summary Update a group
+ */
+export declare const UpdateStatusPageGroupParams: zod.ZodObject<{
+    groupId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const UpdateStatusPageGroupBody: zod.ZodObject<{
+    collapsed: zod.ZodDefault<zod.ZodBoolean>;
+    description: zod.ZodOptional<zod.ZodString>;
+    name: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * The components in it are **not deleted**. They return to the top level as ungrouped components, keeping their availability history and the incident notices that reference them.
+ * @summary Delete a group
+ */
+export declare const DeleteStatusPageGroupParams: zod.ZodObject<{
+    groupId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * @summary Set the order of components within a group
+ */
+export declare const PutStatusPageGroupOrderParams: zod.ZodObject<{
+    groupId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const PutStatusPageGroupOrderBody: zod.ZodObject<{
+    component_ids: zod.ZodArray<zod.ZodUUID>;
+}, zod.z.core.$strict>;
+/**
+ * `name` is **customer-facing copy** and appears verbatim on the public page; do not use machine names.
+ *
+ * `auto_status_min_severity` sets how severe an alert must be before it changes the status of this row; anything below it has no effect. The default is AVERAGE. Lower settings tend to keep the page permanently off-green, at which point people stop reading it.
+ * @summary Create a component
+ */
+export declare const CreateStatusPageComponentBody: zod.ZodObject<{
+    auto_status_min_severity: zod.ZodDefault<zod.ZodEnum<{
+        INFORMATION: "INFORMATION";
+        WARNING: "WARNING";
+        AVERAGE: "AVERAGE";
+        HIGH: "HIGH";
+        DISASTER: "DISASTER";
+        ANY: "ANY";
+    }>>;
+    description: zod.ZodOptional<zod.ZodString>;
+    group_id: zod.ZodOptional<zod.ZodUUID>;
+    name: zod.ZodString;
+    only_show_if_degraded: zod.ZodDefault<zod.ZodBoolean>;
+    show_uptime: zod.ZodDefault<zod.ZodBoolean>;
+    started_on: zod.ZodOptional<zod.z.ZodISODateTime>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a component
+ */
+export declare const GetStatusPageComponentParams: zod.ZodObject<{
+    componentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * `started_on` cannot be changed: it determines where the availability bar stops showing as unmeasured, and changing it would rewrite history that has already been published.
+ * @summary Update a component
+ */
+export declare const UpdateStatusPageComponentParams: zod.ZodObject<{
+    componentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const UpdateStatusPageComponentBody: zod.ZodObject<{
+    auto_status_min_severity: zod.ZodDefault<zod.ZodEnum<{
+        INFORMATION: "INFORMATION";
+        WARNING: "WARNING";
+        AVERAGE: "AVERAGE";
+        HIGH: "HIGH";
+        DISASTER: "DISASTER";
+        ANY: "ANY";
+    }>>;
+    description: zod.ZodOptional<zod.ZodString>;
+    group_id: zod.ZodOptional<zod.ZodUUID>;
+    name: zod.ZodString;
+    only_show_if_degraded: zod.ZodDefault<zod.ZodBoolean>;
+    show_uptime: zod.ZodDefault<zod.ZodBoolean>;
+    started_on: zod.ZodOptional<zod.z.ZodISODateTime>;
+}, zod.z.core.$strict>;
+/**
+ * Its availability history is removed along with it. Passages in already-published notices that refer to it are retained, since customers may already have read them.
+ * @summary Delete a component
+ */
+export declare const DeleteStatusPageComponentParams: zod.ZodObject<{
+    componentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Monitored sources are internal information and **never appear on the public page**.
+ * @summary List the monitored sources bound to a component
+ */
+export declare const ListStatusPageComponentSourcesParams: zod.ZodObject<{
+    componentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Submits the **complete** set of sources; anything not listed is unbound.
+ *
+ * Once bound, alerts on these machines and web checks drive the status of the component automatically: DISASTER and HIGH are reported as a major outage, AVERAGE as a partial outage, and WARNING as degraded performance. Alerts below `auto_status_min_severity` have no effect.
+ *
+ * `show_url` controls whether the checked address is shown on the public page. It is off by default.
+ * @summary Set the complete list of monitored sources for a component
+ */
+export declare const PutStatusPageComponentSourcesParams: zod.ZodObject<{
+    componentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const PutStatusPageComponentSourcesBody: zod.ZodObject<{
+    servers: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        server_id: zod.ZodUUID;
+    }, zod.z.core.$strict>>>;
+    web_checks: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        show_url: zod.ZodDefault<zod.ZodBoolean>;
+        web_check_id: zod.ZodUUID;
+    }, zod.z.core.$strict>>>;
+}, zod.z.core.$strict>;
+/**
+ * These are **customer-facing notices**, distinct from the monitoring incidents under `/incidents`. Nothing from the latter is carried over; the text here is written by your team.
+ * @summary List the incident notices on the status page
+ */
+export declare const listStatusPageIncidentsQueryLimitDefault = 50;
+export declare const listStatusPageIncidentsQueryLimitMax = 200;
+export declare const listStatusPageIncidentsQueryOffsetDefault = 0;
+export declare const listStatusPageIncidentsQueryOffsetMin = 0;
+export declare const listStatusPageIncidentsQueryOffsetMax = 10000;
+export declare const ListStatusPageIncidentsQueryParams: zod.ZodObject<{
+    limit: zod.ZodDefault<zod.ZodInt>;
+    offset: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * Publishing a notice and writing its first update are a single operation: a notice with no updates would appear as a bare title on a page that has already been delivered to readers.
+ *
+ * `started_at` is when the **incident began**, not when the notice was published. The two are usually minutes to hours apart, and using the publication time would understate the impact window that customers can compare against their own logs. Backfilling a past incident relies on the same field.
+ *
+ * The statuses given in `components` take effect on the public page immediately and count towards availability.
+ * @summary Publish an incident notice
+ */
+export declare const PublishStatusPageIncidentBody: zod.ZodObject<{
+    body: zod.ZodString;
+    components: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        component_id: zod.ZodUUID;
+        status: zod.ZodOptional<zod.ZodEnum<{
+            OPERATIONAL: "OPERATIONAL";
+            DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+            PARTIAL_OUTAGE: "PARTIAL_OUTAGE";
+            MAJOR_OUTAGE: "MAJOR_OUTAGE";
+            UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+        }>>;
+    }, zod.z.core.$strict>>>;
+    impact: zod.ZodOptional<zod.ZodEnum<{
+        NONE: "NONE";
+        MINOR: "MINOR";
+        MAJOR: "MAJOR";
+        CRITICAL: "CRITICAL";
+    }>>;
+    incident_status: zod.ZodDefault<zod.ZodEnum<{
+        RESOLVED: "RESOLVED";
+        INVESTIGATING: "INVESTIGATING";
+        IDENTIFIED: "IDENTIFIED";
+        MONITORING: "MONITORING";
+    }>>;
+    name: zod.ZodString;
+    published_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+    started_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get an incident notice
+ */
+export declare const GetStatusPageIncidentParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Published updates are never modified; a correction is issued as a new update. Customers may already have forwarded the original, and a silent rewrite would leave the two sides with different histories.
+ *
+ * `components` lists only the components **being changed** by this update; those not listed keep their current status. Setting `status` to `RESOLVED` returns every component this notice has affected to operational and closes the notice. A closed notice accepts no further updates.
+ * @summary Append an update to an incident notice
+ */
+export declare const PostStatusPageIncidentUpdateParams: zod.ZodObject<{
+    incidentId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const PostStatusPageIncidentUpdateBody: zod.ZodObject<{
+    body: zod.ZodString;
+    components: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        component_id: zod.ZodUUID;
+        status: zod.ZodOptional<zod.ZodEnum<{
+            OPERATIONAL: "OPERATIONAL";
+            DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+            PARTIAL_OUTAGE: "PARTIAL_OUTAGE";
+            MAJOR_OUTAGE: "MAJOR_OUTAGE";
+            UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+        }>>;
+    }, zod.z.core.$strict>>>;
+    incident_status: zod.ZodOptional<zod.ZodEnum<{
+        RESOLVED: "RESOLVED";
+        INVESTIGATING: "INVESTIGATING";
+        IDENTIFIED: "IDENTIFIED";
+        MONITORING: "MONITORING";
+    }>>;
+    published_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+}, zod.z.core.$strict>;
+/**
+ * @summary List scheduled maintenance
+ */
+export declare const listStatusPageMaintenancesQueryLimitDefault = 50;
+export declare const listStatusPageMaintenancesQueryLimitMax = 200;
+export declare const listStatusPageMaintenancesQueryOffsetDefault = 0;
+export declare const listStatusPageMaintenancesQueryOffsetMin = 0;
+export declare const listStatusPageMaintenancesQueryOffsetMax = 10000;
+export declare const ListStatusPageMaintenancesQueryParams: zod.ZodObject<{
+    limit: zod.ZodDefault<zod.ZodInt>;
+    offset: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * Maintenance starts and finishes automatically at the scheduled times; nobody needs to be present. While it runs, the affected components are shown as under maintenance and **availability is not reduced** — planned work should not consume the availability you promise to customers, which is the point of announcing it in advance.
+ *
+ * This is separate from `/maintenance-windows`, which suppresses alerting for a period. This endpoint announces the work to your customers. The two are usually created together: without suppression, restarts during the maintenance raise alerts and mark the components unavailable.
+ * @summary Schedule maintenance
+ */
+export declare const ScheduleStatusPageMaintenanceBody: zod.ZodObject<{
+    body: zod.ZodString;
+    components: zod.ZodArray<zod.ZodObject<{
+        component_id: zod.ZodUUID;
+        component_status: zod.ZodDefault<zod.ZodEnum<{
+            DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+            UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+        }>>;
+    }, zod.z.core.$strict>>;
+    name: zod.ZodString;
+    scheduled_for: zod.z.ZodISODateTime;
+    scheduled_until: zod.z.ZodISODateTime;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a scheduled maintenance
+ */
+export declare const GetStatusPageMaintenanceParams: zod.ZodObject<{
+    maintenanceId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Cancelled rather than deleted, so that readers who saw the announcement have an explanation. Maintenance that has already started cannot be cancelled; finish it early instead.
+ * @summary Cancel a maintenance that has not started
+ */
+export declare const CancelStatusPageMaintenanceParams: zod.ZodObject<{
+    maintenanceId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Optional: maintenance finishes on its own at the scheduled end time. Use this endpoint when the work is done ahead of schedule; the affected components return to operational immediately.
+ * @summary Finish a running maintenance early
+ */
+export declare const CompleteStatusPageMaintenanceParams: zod.ZodObject<{
+    maintenanceId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a project-level web check
+ */
+export declare const GetProjectWebCheckParams: zod.ZodObject<{
+    checkId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * **Create or replace**: to modify a check, call this endpoint again with the same id.
+ *
+ * Unlike `/servers/{serverId}/web-checks/{checkId}`, this check does not belong to any machine — use it when the target is simply a URL. Nothing needs to be enrolled first.
+ *
+ * A check bound to a machine is removed together with that machine; a project-level check is not. Where a check belongs cannot be changed afterwards: move it by deleting and recreating it.
+ * @summary Create a web check that is not tied to a machine, or replace it by the same id
+ */
+export declare const PutProjectWebCheckParams: zod.ZodObject<{
+    checkId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const PutProjectWebCheckBody: zod.ZodObject<{
+    interval_seconds: zod.ZodOptional<zod.ZodInt>;
+    response_time_threshold_seconds: zod.ZodOptional<zod.ZodInt>;
+    retries: zod.ZodOptional<zod.ZodInt>;
+    steps: zod.ZodNullable<zod.ZodArray<zod.ZodObject<{
+        expected_status_codes: zod.ZodOptional<zod.ZodString>;
+        follow_redirects: zod.ZodOptional<zod.ZodBoolean>;
+        name: zod.ZodString;
+        required_pattern: zod.ZodOptional<zod.ZodString>;
+        url: zod.ZodString;
+    }, zod.z.core.$strict>>>;
+    timeout_seconds: zod.ZodOptional<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * The corresponding check task and trigger are removed from the monitoring system as well.
+ * @summary Delete a project-level web check
+ */
+export declare const DeleteProjectWebCheckParams: zod.ZodObject<{
+    checkId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * The domain must already point at the status page by CNAME. Binding is rejected until it does, and the error carries both the expected and the observed target.
+ *
+ * Ownership is verified before the domain is stored, and it is verified again before each certificate is issued: a domain whose CNAME is later removed stops being served.
+ *
+ * A certificate is requested in the background — this call does not wait for it. Poll GET on this endpoint to follow its progress; until a certificate is active, the domain does not serve HTTPS while the page remains reachable at its shared address.
+ * @summary Bind a custom domain to this status page
+ */
+export declare const PutStatusPageDomainBody: zod.ZodObject<{
+    domain: zod.ZodString;
+}, zod.z.core.$strict>;