@leaflow/sdk 0.0.0-dev.47.g94a977a → 0.0.0-dev.470.g87d6289

package/dist/monitoring/v1/generated/models.d.ts

@@ -0,0 +1,1681 @@
+/**
+ * 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
+ */
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
+/**
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
+ */
+export type ErrorStatusMetadata = {
+    [key: string]: string;
+};
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
+    message: string;
+    /**
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
+     */
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
+}
+export interface IncidentFollowerResource {
+    display_name: string;
+    followed_at: string;
+    user_id: string;
+}
+export interface MonitoringItemResource {
+    /** Such as last, avg, min or max */
+    aggregation_function: string;
+    evaluation_window_seconds: number;
+    item_id: string;
+    key: string;
+    name: string;
+    operator: string;
+    /**
+     * Present only when `threshold_status` is RESOLVED
+     * @nullable
+     */
+    threshold: number | null;
+    threshold_status: string;
+    /** The value at the moment of the trigger, stored as collected */
+    value: string;
+}
+export interface TagResource {
+    tag: string;
+    value: string;
+}
+/**
+ * Whether monitoring considers the problem recovered. Independent of whether anyone has closed the incident
+ */
+export type IncidentResourceIncidentStatus = (typeof IncidentResourceIncidentStatus)[keyof typeof IncidentResourceIncidentStatus];
+export declare const IncidentResourceIncidentStatus: {
+    readonly PROBLEM: "PROBLEM";
+    readonly RESOLVED: "RESOLVED";
+};
+export type IncidentResourceSeverity = (typeof IncidentResourceSeverity)[keyof typeof IncidentResourceSeverity];
+export declare const IncidentResourceSeverity: {
+    readonly NOT_CLASSIFIED: "NOT_CLASSIFIED";
+    readonly INFORMATION: "INFORMATION";
+    readonly WARNING: "WARNING";
+    readonly AVERAGE: "AVERAGE";
+    readonly HIGH: "HIGH";
+    readonly DISASTER: "DISASTER";
+};
+export interface IncidentResource {
+    acknowledge_message: string;
+    acknowledged: boolean;
+    /** @nullable */
+    acknowledged_at: string | null;
+    acknowledged_by_display_name: string;
+    acknowledged_by_user_id: string;
+    /** @nullable */
+    assigned_at: string | null;
+    assignee_display_name: string;
+    assignee_user_id: string;
+    close_message: string;
+    close_reason: string;
+    /** @nullable */
+    closed_at: string | null;
+    closed_by_display_name: string;
+    closed_by_user_id: string;
+    duration_seconds: number;
+    /** @nullable */
+    followers: IncidentFollowerResource[] | null;
+    host_connection: string;
+    host_display_name: string;
+    id: string;
+    /** Whether monitoring considers the problem recovered. Independent of whether anyone has closed the incident */
+    incident_status: IncidentResourceIncidentStatus;
+    /** @nullable */
+    items: MonitoringItemResource[] | null;
+    name: string;
+    /** The operational data line configured on the trigger */
+    operational_data: string;
+    project_id: string;
+    /** @nullable */
+    resolved_at: string | null;
+    resolved_trigger_expression: string;
+    /**
+     * The machine this alert is about. Null when the alert is not about a machine
+     * @nullable
+     */
+    server_id: string | null;
+    /** Empty when server_id is null */
+    server_name: string;
+    severity: IncidentResourceSeverity;
+    started_at: string;
+    /** @nullable */
+    tags: TagResource[] | null;
+    trigger_expression: string;
+    /**
+     * The web check that reported this alert. Null when the alert did not come from a web check. Both this and server_id are set when the check runs on one of your machines
+     * @nullable
+     */
+    web_check_id: string | null;
+    zabbix_event_id: string;
+}
+export interface LengthAwarePageIncidentResource {
+    /** The records in this page */
+    items: IncidentResource[];
+    /** Maximum records per page, echoing the request */
+    limit: number;
+    /** Number of records skipped, echoing the request */
+    offset: number;
+    /** Total number of matches, not just this page */
+    total: number;
+}
+export interface AcknowledgeIncidentRequestBody {
+    /**
+     * Also written to the acknowledgement record in the monitoring system
+     * @maxLength 2000
+     */
+    message?: string;
+}
+export interface AssignIncidentRequestBody {
+    /**
+     * Defaults to the user id. The timeline keeps a copy of the name as it was at the time
+     * @maxLength 255
+     */
+    assignee_display_name?: string;
+    /** @maxLength 255 */
+    assignee_user_id?: string;
+}
+export type CloseIncidentRequestBodyReason = (typeof CloseIncidentRequestBodyReason)[keyof typeof CloseIncidentRequestBodyReason];
+export declare const CloseIncidentRequestBodyReason: {
+    readonly RECOVERED: "RECOVERED";
+    readonly FIXED: "FIXED";
+    readonly FALSE_POSITIVE: "FALSE_POSITIVE";
+    readonly DUPLICATE: "DUPLICATE";
+    readonly NO_ACTION_REQUIRED: "NO_ACTION_REQUIRED";
+    readonly ACCEPTED_RISK: "ACCEPTED_RISK";
+    readonly OTHER: "OTHER";
+};
+export interface CloseIncidentRequestBody {
+    /**
+     * Required when `reason` is OTHER; the request is rejected otherwise
+     * @maxLength 2000
+     */
+    message?: string;
+    reason: CloseIncidentRequestBodyReason;
+}
+export interface AddCommentRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 2000
+     */
+    message: string;
+}
+export type IncidentActivityResourceActivityType = (typeof IncidentActivityResourceActivityType)[keyof typeof IncidentActivityResourceActivityType];
+export declare const IncidentActivityResourceActivityType: {
+    readonly OPENED: "OPENED";
+    readonly RECOVERED: "RECOVERED";
+    readonly ACKNOWLEDGED: "ACKNOWLEDGED";
+    readonly ASSIGNED: "ASSIGNED";
+    readonly UNASSIGNED: "UNASSIGNED";
+    readonly FOLLOWER_ADDED: "FOLLOWER_ADDED";
+    readonly FOLLOWER_REMOVED: "FOLLOWER_REMOVED";
+    readonly COMMENT: "COMMENT";
+    readonly CLOSED: "CLOSED";
+    readonly REOPENED: "REOPENED";
+};
+export type IncidentActivityResourceSource = (typeof IncidentActivityResourceSource)[keyof typeof IncidentActivityResourceSource];
+export declare const IncidentActivityResourceSource: {
+    readonly SYSTEM: "SYSTEM";
+    readonly OPERATOR: "OPERATOR";
+    readonly ZABBIX: "ZABBIX";
+};
+export interface IncidentActivityResource {
+    activity_type: IncidentActivityResourceActivityType;
+    actor_display_name: string;
+    /** The operator. Empty when the source is SYSTEM or ZABBIX */
+    actor_user_id: string;
+    close_reason: string;
+    id: string;
+    incident_id: string;
+    message: string;
+    occurred_at: string;
+    source: IncidentActivityResourceSource;
+    subject_display_name: string;
+    /** The user who was assigned, or removed from the followers */
+    subject_user_id: string;
+}
+export interface SetFollowingRequestBody {
+    following: boolean;
+}
+export interface CursorPageIncidentActivityResource {
+    /** The records in this page */
+    items: IncidentActivityResource[];
+    /** Cursor for the next page. Empty means the end has been reached */
+    next_cursor: string;
+}
+export type MaintenancePeriodResourceKind = (typeof MaintenancePeriodResourceKind)[keyof typeof MaintenancePeriodResourceKind];
+export declare const MaintenancePeriodResourceKind: {
+    readonly ONCE: "ONCE";
+    readonly DAILY: "DAILY";
+    readonly WEEKLY: "WEEKLY";
+};
+export interface MaintenancePeriodResource {
+    duration_seconds: number;
+    /** DAILY and WEEKLY: every N days or every N weeks */
+    every: number;
+    kind: MaintenancePeriodResourceKind;
+    /** DAILY and WEEKLY: seconds from midnight, in the timezone of the window */
+    start_time_seconds: number;
+    /**
+     * Present only for ONCE
+     * @nullable
+     */
+    starts_at: string | null;
+    /** WEEKLY: bitmap of weekdays, **Monday is the lowest bit** */
+    weekdays: number;
+}
+export type MaintenanceWindowResourceSyncStatus = (typeof MaintenanceWindowResourceSyncStatus)[keyof typeof MaintenanceWindowResourceSyncStatus];
+export declare const MaintenanceWindowResourceSyncStatus: {
+    readonly PENDING: "PENDING";
+    readonly ACTIVE: "ACTIVE";
+    readonly FAILED: "FAILED";
+    readonly EXPIRED: "EXPIRED";
+};
+export interface MaintenanceWindowResource {
+    active_since: string;
+    active_till: string;
+    description: string;
+    last_error: string;
+    name: string;
+    period: MaintenancePeriodResource;
+    project_id: string;
+    /**
+     * Empty covers the **entire project**
+     * @nullable
+     */
+    server_ids: string[] | null;
+    sync_status: MaintenanceWindowResourceSyncStatus;
+    timezone: string;
+    window_id: string;
+}
+export interface MaintenanceWindowListResponseBody {
+    /** @nullable */
+    items: MaintenanceWindowResource[] | null;
+}
+export type MaintenancePeriodRequestKind = (typeof MaintenancePeriodRequestKind)[keyof typeof MaintenancePeriodRequestKind];
+export declare const MaintenancePeriodRequestKind: {
+    readonly ONCE: "ONCE";
+    readonly DAILY: "DAILY";
+    readonly WEEKLY: "WEEKLY";
+};
+export interface MaintenancePeriodRequest {
+    /** @minimum 0 */
+    duration_seconds?: number;
+    /**
+     * DAILY and WEEKLY: every N days or every N weeks
+     * @minimum 0
+     */
+    every?: number;
+    kind: MaintenancePeriodRequestKind;
+    /**
+     * DAILY and WEEKLY: seconds from midnight, in the timezone of the window
+     * @minimum 0
+     * @maximum 86399
+     */
+    start_time_seconds?: number;
+    /** Used only by ONCE */
+    starts_at?: string;
+    /**
+     * WEEKLY: bitmap of weekdays, **Monday is the lowest bit**
+     * @minimum 0
+     * @maximum 127
+     */
+    weekdays?: number;
+}
+export interface PutMaintenanceWindowRequestBody {
+    /** Start of the period in which the rule is effective */
+    active_since: string;
+    active_till: string;
+    /** @maxLength 2000 */
+    description?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    period: MaintenancePeriodRequest;
+    /** @nullable */
+    server_ids?: string[] | null;
+    /**
+     * IANA name such as Asia/Shanghai. Empty uses the configured default
+     * @maxLength 64
+     */
+    timezone?: string;
+}
+export interface CountResource {
+    count: number;
+    key: string;
+}
+export interface ProjectOverviewResource {
+    monitored_servers: number;
+    /** @nullable */
+    problem_counts: CountResource[] | null;
+    /** @nullable */
+    reachability_counts: CountResource[] | null;
+    total_servers: number;
+}
+export type ItemResourceValueType = (typeof ItemResourceValueType)[keyof typeof ItemResourceValueType];
+export declare const ItemResourceValueType: {
+    readonly FLOAT: "FLOAT";
+    readonly CHARACTER: "CHARACTER";
+    readonly LOG: "LOG";
+    readonly UNSIGNED: "UNSIGNED";
+    readonly TEXT: "TEXT";
+};
+export interface ItemResource {
+    item_id: string;
+    key: string;
+    /** @nullable */
+    last_collected_at: string | null;
+    last_value: string;
+    name: string;
+    /** @nullable */
+    tags: TagResource[] | null;
+    units: string;
+    value_type: ItemResourceValueType;
+}
+export interface ItemListResponseBody {
+    /** @nullable */
+    items: ItemResource[] | null;
+}
+export interface MetricPointResource {
+    max_value: number;
+    min_value: number;
+    timestamp: string;
+    value: number;
+}
+export interface MetricSeriesResource {
+    item_id: string;
+    item_key: string;
+    item_name: string;
+    /** @nullable */
+    points: MetricPointResource[] | null;
+    units: string;
+}
+export interface ItemThresholdResource {
+    aggregation_function: string;
+    evaluation_window_seconds: number;
+    item_id: string;
+    operator: string;
+    severity: string;
+    threshold: number;
+    /** Labels the line in the chart legend */
+    trigger_name: string;
+}
+export interface MetricResponseBody {
+    downsampled: boolean;
+    effective_from: string;
+    effective_to: string;
+    /** Data comes from hourly aggregates, one point per hour */
+    from_trends: boolean;
+    /** @nullable */
+    series: MetricSeriesResource[] | null;
+    /** @nullable */
+    thresholds: ItemThresholdResource[] | null;
+    truncated: boolean;
+}
+export interface HostInterfaceResource {
+    available: boolean;
+    dns: string;
+    ip: string;
+    port: number;
+    use_ip: boolean;
+}
+/**
+ * Hardware and system inventory collected automatically: CPU, memory, operating system and so on
+ */
+export type ServerResourcesResourceInventory = {
+    [key: string]: string;
+};
+export interface ServerResourcesResource {
+    /** @nullable */
+    interfaces: HostInterfaceResource[] | null;
+    /** Hardware and system inventory collected automatically: CPU, memory, operating system and so on */
+    inventory: ServerResourcesResourceInventory;
+    /** @nullable */
+    tags: TagResource[] | null;
+}
+/**
+ * AGENT_DOWN means the agent is unreachable while the machine is still alive; UNREACHABLE means neither can be established
+ */
+export type SnapshotResourceAgentReachability = (typeof SnapshotResourceAgentReachability)[keyof typeof SnapshotResourceAgentReachability];
+export declare const SnapshotResourceAgentReachability: {
+    readonly UNKNOWN: "UNKNOWN";
+    readonly REACHABLE: "REACHABLE";
+    readonly AGENT_DOWN: "AGENT_DOWN";
+    readonly UNREACHABLE: "UNREACHABLE";
+};
+export interface SnapshotResource {
+    agent_error: string;
+    /** AGENT_DOWN means the agent is unreachable while the machine is still alive; UNREACHABLE means neither can be established */
+    agent_reachability: SnapshotResourceAgentReachability;
+    /** @nullable */
+    last_collected_at: string | null;
+    monitoring_enabled: boolean;
+    /** @nullable */
+    problem_counts: CountResource[] | null;
+}
+export interface TopItemResource {
+    item_key: string;
+    server_id: string;
+    units: string;
+    value: number;
+}
+export interface TopItemListResponseBody {
+    /** @nullable */
+    items: TopItemResource[] | null;
+}
+/**
+ * The shape of the accepted value. Surrounding whitespace is trimmed before the value is checked, and an omitted or empty value is replaced by `default` and not checked at all.
+ *
+ * - `string` — no constraint; empty is accepted
+ * - `non_empty_string` — must not be empty once trimmed
+ * - `percent` — a number in the **closed** interval 0 to 100; fractions are accepted
+ * - `positive_number` — a number **strictly** greater than 0; fractions are accepted
+ * - `port` — an integer from 1 to 65535 inclusive; `8080/tcp` is not a port
+ * - `host` — an IP address, or a hostname of at most 255 characters whose dot-separated labels are at most 63 characters of `A-Z a-z 0-9 - _` and neither begin nor end with `-`. A single label such as `localhost` is accepted, as is a trailing dot
+ * - `ip_or_empty` — an IP address, or empty to mean "not specified"
+ * - `regexp` — must compile as a **Go RE2** pattern. RE2 has no backreferences and no lookaround, so a pattern that a browser's `new RegExp()` accepts may still be rejected here. Validating client-side narrows the gap but does not close it
+ */
+export type TemplateCatalogParameterResourceKind = (typeof TemplateCatalogParameterResourceKind)[keyof typeof TemplateCatalogParameterResourceKind];
+export declare const TemplateCatalogParameterResourceKind: {
+    readonly string: "string";
+    readonly non_empty_string: "non_empty_string";
+    readonly percent: "percent";
+    readonly positive_number: "positive_number";
+    readonly port: "port";
+    readonly host: "host";
+    readonly ip_or_empty: "ip_or_empty";
+    readonly regexp: "regexp";
+};
+export interface TemplateCatalogParameterResource {
+    /** The value that takes effect when the parameter is omitted. An empty string is a real default, not an absent one */
+    default: string;
+    /**
+     * The shape of the accepted value. Surrounding whitespace is trimmed before the value is checked, and an omitted or empty value is replaced by `default` and not checked at all.
+     *
+     * - `string` — no constraint; empty is accepted
+     * - `non_empty_string` — must not be empty once trimmed
+     * - `percent` — a number in the **closed** interval 0 to 100; fractions are accepted
+     * - `positive_number` — a number **strictly** greater than 0; fractions are accepted
+     * - `port` — an integer from 1 to 65535 inclusive; `8080/tcp` is not a port
+     * - `host` — an IP address, or a hostname of at most 255 characters whose dot-separated labels are at most 63 characters of `A-Z a-z 0-9 - _` and neither begin nor end with `-`. A single label such as `localhost` is accepted, as is a trailing dot
+     * - `ip_or_empty` — an IP address, or empty to mean "not specified"
+     * - `regexp` — must compile as a **Go RE2** pattern. RE2 has no backreferences and no lookaround, so a pattern that a browser's `new RegExp()` accepts may still be rejected here. Validating client-side narrows the gap but does not close it
+     */
+    kind: TemplateCatalogParameterResourceKind;
+    /** The key to use in `template_bindings[].parameters`. It is not the Zabbix macro name, which is internal and changes between Zabbix versions */
+    name: string;
+    /** Independent of `default`. The three NGINX connection parameters carry a default and are still required, because the template's own default (localhost:80/basic_status) is almost never right */
+    required: boolean;
+    /** Supplied in clear text and never returned. A configured one is reported by name only, through `configured_secret_parameters` on the bound template. When updating a machine that already has one stored, omit it to keep the stored value and supply it only to replace it — a caller cannot read it back, so requiring it on every write would make resuming collection impossible */
+    secret: boolean;
+}
+export interface TemplateCatalogEntryResource {
+    /** Exactly one template with this set must be bound to every machine. Binding none enrolls a machine that can never alert; binding both loads the Linux and Windows items onto one machine, half of which must fail */
+    is_base: boolean;
+    /** False means the template collects without an agent on the machine — ICMP_PING is pinged by the Zabbix server, PROXMOX_VE is polled over the PVE API */
+    needs_agent: boolean;
+    /**
+     * In declaration order — connection parameters first, thresholds after — and meant to be rendered in that order. It is deliberately not alphabetical, which would split a template's connection parameters apart with thresholds between them even though they only make sense filled in together
+     * @nullable
+     */
+    parameters: TemplateCatalogParameterResource[] | null;
+    /**
+     * Templates that must be bound alongside this one. Values are `template_key`s
+     * @nullable
+     */
+    requires: string[] | null;
+    /** Whether this template may be bound when `agent_mode` is ACTIVE. It already combines both reasons it may not be — no active variant exists, or this deployment does not have one installed — because the two are rejected identically and call for the same fix */
+    supports_active_mode: boolean;
+    template_key: string;
+}
+export interface TemplateCatalogResponseBody {
+    /** @nullable */
+    items: TemplateCatalogEntryResource[] | null;
+}
+export type ServerTemplateResourceParameters = {
+    [key: string]: string;
+};
+export interface ServerTemplateResource {
+    /** @nullable */
+    configured_secret_parameters: string[] | null;
+    parameters: ServerTemplateResourceParameters;
+    template_key: string;
+    zabbix_template_id: string;
+    zabbix_template_name: string;
+}
+export type ServerResourceAddressKind = (typeof ServerResourceAddressKind)[keyof typeof ServerResourceAddressKind];
+export declare const ServerResourceAddressKind: {
+    readonly ip: "ip";
+    readonly dns: "dns";
+};
+export type ServerResourceAgentMode = (typeof ServerResourceAgentMode)[keyof typeof ServerResourceAgentMode];
+export declare const ServerResourceAgentMode: {
+    readonly PASSIVE: "PASSIVE";
+    readonly ACTIVE: "ACTIVE";
+};
+/**
+ * Consult `last_error` when this is FAILED
+ */
+export type ServerResourceMonitoringStatus = (typeof ServerResourceMonitoringStatus)[keyof typeof ServerResourceMonitoringStatus];
+export declare const ServerResourceMonitoringStatus: {
+    readonly PENDING: "PENDING";
+    readonly ACTIVE: "ACTIVE";
+    readonly DISABLED: "DISABLED";
+    readonly FAILED: "FAILED";
+};
+export interface ServerResource {
+    address: string;
+    address_kind: ServerResourceAddressKind;
+    agent_mode: ServerResourceAgentMode;
+    agent_port: number;
+    created_at: string;
+    description: string;
+    id: string;
+    last_error: string;
+    /** Consult `last_error` when this is FAILED */
+    monitoring_status: ServerResourceMonitoringStatus;
+    name: string;
+    project_id: string;
+    /** @nullable */
+    templates: ServerTemplateResource[] | null;
+    updated_at: string;
+    /** The Hostname in the agent configuration must match this value; active checks identify the machine by it */
+    zabbix_host_name: string;
+}
+export interface LengthAwarePageServerResource {
+    /** The records in this page */
+    items: ServerResource[];
+    /** Maximum records per page, echoing the request */
+    limit: number;
+    /** Number of records skipped, echoing the request */
+    offset: number;
+    /** Total number of matches, not just this page */
+    total: number;
+}
+/**
+ * Parameters declared by the template, keyed by `name` from `GET /templates`. This is a full replacement: a parameter that is omitted takes the `default` reported there, so send back the whole `parameters` map read from the machine rather than only the field being changed.
+ *
+ * Secret parameters are the one exception, because they are never returned and so cannot be sent back. Omit one to keep the value already stored, and supply it only to replace it. An empty or blank value counts as omitted.
+ */
+export type TemplateBindingRequestParameters = {
+    [key: string]: string;
+};
+export type TemplateBindingRequestTemplateKey = (typeof TemplateBindingRequestTemplateKey)[keyof typeof TemplateBindingRequestTemplateKey];
+export declare const TemplateBindingRequestTemplateKey: {
+    readonly LINUX: "LINUX";
+    readonly SYSTEMD: "SYSTEMD";
+    readonly DOCKER: "DOCKER";
+    readonly ICMP_PING: "ICMP_PING";
+    readonly NGINX: "NGINX";
+    readonly PHP_FPM: "PHP_FPM";
+    readonly WEBSITE_CERTIFICATE: "WEBSITE_CERTIFICATE";
+    readonly WINDOWS: "WINDOWS";
+    readonly SMART: "SMART";
+    readonly NVIDIA: "NVIDIA";
+    readonly PROXMOX_VE: "PROXMOX_VE";
+};
+export interface TemplateBindingRequest {
+    /**
+     * Parameters declared by the template, keyed by `name` from `GET /templates`. This is a full replacement: a parameter that is omitted takes the `default` reported there, so send back the whole `parameters` map read from the machine rather than only the field being changed.
+     *
+     * Secret parameters are the one exception, because they are never returned and so cannot be sent back. Omit one to keep the value already stored, and supply it only to replace it. An empty or blank value counts as omitted.
+     */
+    parameters?: TemplateBindingRequestParameters;
+    template_key: TemplateBindingRequestTemplateKey;
+}
+export type EnableMonitoringRequestBodyAddressKind = (typeof EnableMonitoringRequestBodyAddressKind)[keyof typeof EnableMonitoringRequestBodyAddressKind];
+export declare const EnableMonitoringRequestBodyAddressKind: {
+    readonly ip: "ip";
+    readonly dns: "dns";
+};
+/**
+ * Empty selects passive mode, which requires the least agent-side configuration
+ */
+export type EnableMonitoringRequestBodyAgentMode = (typeof EnableMonitoringRequestBodyAgentMode)[keyof typeof EnableMonitoringRequestBodyAgentMode];
+export declare const EnableMonitoringRequestBodyAgentMode: {
+    readonly PASSIVE: "PASSIVE";
+    readonly ACTIVE: "ACTIVE";
+};
+export interface EnableMonitoringRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    address: string;
+    address_kind: EnableMonitoringRequestBodyAddressKind;
+    /** Empty selects passive mode, which requires the least agent-side configuration */
+    agent_mode?: EnableMonitoringRequestBodyAgentMode;
+    /**
+     * 0 uses the default of 10050
+     * @minimum 0
+     * @maximum 65535
+     */
+    agent_port?: number;
+    /** @maxLength 2000 */
+    description?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /** @nullable */
+    template_bindings?: TemplateBindingRequest[] | null;
+}
+export interface EnrollmentResource {
+    /** Includes the PSK. Like `tls_psk`, it is returned only this once */
+    install_command: string;
+    install_script_url: string;
+    /** **Returned only this once** */
+    tls_psk: string;
+    tls_psk_identity: string;
+    zabbix_host_name: string;
+    /** The Server and ServerActive values for the agent configuration */
+    zabbix_server_address: string;
+}
+export interface ServerEnrollmentResponseBody {
+    enrollment: EnrollmentResource;
+    server: ServerResource;
+}
+/**
+ * Must be supplied together with `address` when changing the address
+ */
+export type UpdateServerRequestBodyAddressKind = (typeof UpdateServerRequestBodyAddressKind)[keyof typeof UpdateServerRequestBodyAddressKind];
+export declare const UpdateServerRequestBodyAddressKind: {
+    readonly ip: "ip";
+    readonly dns: "dns";
+};
+/**
+ * Changing the collection mode rebinds every template to the corresponding variant
+ */
+export type UpdateServerRequestBodyAgentMode = (typeof UpdateServerRequestBodyAgentMode)[keyof typeof UpdateServerRequestBodyAgentMode];
+export declare const UpdateServerRequestBodyAgentMode: {
+    readonly PASSIVE: "PASSIVE";
+    readonly ACTIVE: "ACTIVE";
+};
+export interface UpdateServerRequestBody {
+    /** @maxLength 255 */
+    address?: string;
+    /** Must be supplied together with `address` when changing the address */
+    address_kind?: UpdateServerRequestBodyAddressKind;
+    /** Changing the collection mode rebinds every template to the corresponding variant */
+    agent_mode?: UpdateServerRequestBodyAgentMode;
+    /**
+     * @minimum 1
+     * @maximum 65535
+     */
+    agent_port?: number;
+    /** @maxLength 2000 */
+    description?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name?: string;
+    template_bindings?: TemplateBindingRequest[];
+}
+export interface WebCheckResultResource {
+    checked_at: string;
+    error: string;
+    /** Index of the failed step, counting from 1. 0 when healthy */
+    failed_step: number;
+    healthy: boolean;
+    response_code: number;
+    response_time_seconds: number;
+}
+export interface WebCheckStepResource {
+    /** Status code expression, such as 200 or 200,301-302 */
+    expected_status_codes: string;
+    follow_redirects: boolean;
+    name: string;
+    required_pattern: string;
+    url: string;
+}
+export type WebCheckResourceSyncStatus = (typeof WebCheckResourceSyncStatus)[keyof typeof WebCheckResourceSyncStatus];
+export declare const WebCheckResourceSyncStatus: {
+    readonly PENDING: "PENDING";
+    readonly ACTIVE: "ACTIVE";
+    readonly FAILED: "FAILED";
+};
+export interface WebCheckResource {
+    check_id: string;
+    interval_seconds: number;
+    last_error: string;
+    response_time_threshold_seconds: number;
+    /** null means the check has not completed a round yet. A zero value would present "not yet known" as "0 seconds, status code 0" */
+    result: WebCheckResultResource | null;
+    retries: number;
+    /** The machine this check is attached to. Empty for a project-level check, which is not tied to any machine */
+    server_id: string;
+    /** @nullable */
+    steps: WebCheckStepResource[] | null;
+    sync_status: WebCheckResourceSyncStatus;
+    timeout_seconds: number;
+}
+export interface WebCheckStepRequest {
+    /**
+     * Status code expression, such as 200 or 200,301-302. Empty disables status code checking
+     * @maxLength 255
+     */
+    expected_status_codes?: string;
+    follow_redirects?: boolean;
+    /** @maxLength 64 */
+    name: string;
+    /**
+     * A string that must appear in the response body
+     * @maxLength 255
+     */
+    required_pattern?: string;
+    /** @maxLength 2048 */
+    url: string;
+}
+export interface PutWebCheckRequestBody {
+    /**
+     * 0 uses the default
+     * @minimum 0
+     */
+    interval_seconds?: number;
+    /**
+     * Slower than this counts as slow. 0 disables the response time check
+     * @minimum 0
+     */
+    response_time_threshold_seconds?: number;
+    /** @minimum 0 */
+    retries?: number;
+    /**
+     * @minItems 1
+     * @nullable
+     */
+    steps: WebCheckStepRequest[] | null;
+    /** @minimum 0 */
+    timeout_seconds?: number;
+}
+export interface WebCheckListResponseBody {
+    /** @nullable */
+    items: WebCheckResource[] | null;
+}
+export interface SLIReportRowResource {
+    downtime_seconds: number;
+    /** A negative value means the budget for this period is already exhausted */
+    error_budget_seconds: number;
+    /** The portion excluded by planned maintenance */
+    excluded_downtime_seconds: number;
+    period_from: string;
+    period_to: string;
+    /** Empty means this row covers the project as a whole */
+    server_id: string;
+    sli_percent: number;
+    uptime_seconds: number;
+}
+export interface SLIReportResponseBody {
+    /** @nullable */
+    rows: SLIReportRowResource[] | null;
+}
+export interface ScheduleWindowResource {
+    end_time_seconds: number;
+    start_time_seconds: number;
+    /** Bitmap of weekdays, **Monday is the lowest bit**, using the same encoding as maintenance windows */
+    weekdays: number;
+}
+export type SLOResourceMinSeverity = (typeof SLOResourceMinSeverity)[keyof typeof SLOResourceMinSeverity];
+export declare const SLOResourceMinSeverity: {
+    readonly ANY: "ANY";
+    readonly INFORMATION: "INFORMATION";
+    readonly WARNING: "WARNING";
+    readonly AVERAGE: "AVERAGE";
+    readonly HIGH: "HIGH";
+    readonly DISASTER: "DISASTER";
+};
+export type SLOResourcePeriod = (typeof SLOResourcePeriod)[keyof typeof SLOResourcePeriod];
+export declare const SLOResourcePeriod: {
+    readonly DAILY: "DAILY";
+    readonly WEEKLY: "WEEKLY";
+    readonly MONTHLY: "MONTHLY";
+    readonly QUARTERLY: "QUARTERLY";
+    readonly ANNUALLY: "ANNUALLY";
+};
+export type SLOResourceSyncStatus = (typeof SLOResourceSyncStatus)[keyof typeof SLOResourceSyncStatus];
+export declare const SLOResourceSyncStatus: {
+    readonly PENDING: "PENDING";
+    readonly ACTIVE: "ACTIVE";
+    readonly FAILED: "FAILED";
+};
+export interface SLOResource {
+    effective_from: string;
+    last_error: string;
+    min_severity: SLOResourceMinSeverity;
+    name: string;
+    period: SLOResourcePeriod;
+    project_id: string;
+    /**
+     * Empty means a 24x7 commitment
+     * @nullable
+     */
+    schedule: ScheduleWindowResource[] | null;
+    slo_id: string;
+    /** Target availability, such as 99.9 */
+    slo_percent: number;
+    sync_status: SLOResourceSyncStatus;
+    timezone: string;
+}
+export interface ScheduleWindowRequest {
+    /**
+     * @minimum 0
+     * @maximum 86400
+     */
+    end_time_seconds?: number;
+    /**
+     * @minimum 0
+     * @maximum 86400
+     */
+    start_time_seconds?: number;
+    /**
+     * Bitmap of weekdays, **Monday is the lowest bit** (1 = Monday … 64 = Sunday)
+     * @minimum 1
+     * @maximum 127
+     */
+    weekdays: number;
+}
+export type PutSLORequestBodyMinSeverity = (typeof PutSLORequestBodyMinSeverity)[keyof typeof PutSLORequestBodyMinSeverity];
+export declare const PutSLORequestBodyMinSeverity: {
+    readonly ANY: "ANY";
+    readonly INFORMATION: "INFORMATION";
+    readonly WARNING: "WARNING";
+    readonly AVERAGE: "AVERAGE";
+    readonly HIGH: "HIGH";
+    readonly DISASTER: "DISASTER";
+};
+/**
+ * Empty selects monthly
+ */
+export type PutSLORequestBodyPeriod = (typeof PutSLORequestBodyPeriod)[keyof typeof PutSLORequestBodyPeriod];
+export declare const PutSLORequestBodyPeriod: {
+    readonly DAILY: "DAILY";
+    readonly WEEKLY: "WEEKLY";
+    readonly MONTHLY: "MONTHLY";
+    readonly QUARTERLY: "QUARTERLY";
+    readonly ANNUALLY: "ANNUALLY";
+};
+export interface PutSLORequestBody {
+    effective_from?: string;
+    min_severity: PutSLORequestBodyMinSeverity;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /** Empty selects monthly */
+    period?: PutSLORequestBodyPeriod;
+    /** @nullable */
+    schedule?: ScheduleWindowRequest[] | null;
+    slo_id: string;
+    /**
+     * Target availability, such as 99.9. At most four decimal places
+     * @minimum 0
+     * @maximum 100
+     */
+    slo_percent: number;
+    /**
+     * Determines the boundaries of each reporting period, that is, the moment each period begins
+     * @maxLength 64
+     */
+    timezone?: string;
+}
+export type StatusPageResourceTheme = (typeof StatusPageResourceTheme)[keyof typeof StatusPageResourceTheme];
+export declare const StatusPageResourceTheme: {
+    readonly AUTO: "AUTO";
+    readonly LIGHT: "LIGHT";
+    readonly DARK: "DARK";
+};
+export interface StatusPageResource {
+    /** #RRGGBB */
+    brand_color: string;
+    created_at: string;
+    /** The custom domain bound to this page. Empty means it is served only at /{slug} under the shared domain */
+    custom_domain: string;
+    footer_text: string;
+    headline: string;
+    logo_url: string;
+    name: string;
+    /** The address this page is served at: the custom domain if one is bound, otherwise the shared domain with the slug, otherwise the shared domain with the project id */
+    public_url: string;
+    published: boolean;
+    /** Whether search engines may index the page */
+    search_engine_index: boolean;
+    /** The readable address segment, empty when none is set. The page is always reachable at /<project id> regardless */
+    slug: string;
+    status_page_id: string;
+    support_url: string;
+    theme: StatusPageResourceTheme;
+    /** Determines where the day boundary falls on the availability bar */
+    timezone: string;
+    updated_at: string;
+    /** Number of days covered by the availability bar */
+    uptime_days: number;
+    /** The text shown on the support link. Empty means the page default is used */
+    support_label: string;
+}
+export type PutStatusPageRequestBodyTheme = (typeof PutStatusPageRequestBodyTheme)[keyof typeof PutStatusPageRequestBodyTheme];
+export declare const PutStatusPageRequestBodyTheme: {
+    readonly AUTO: "AUTO";
+    readonly LIGHT: "LIGHT";
+    readonly DARK: "DARK";
+};
+export interface PutStatusPageRequestBody {
+    /**
+     * #RRGGBB. Applied to the page styling; only a strict six-digit hexadecimal value is accepted
+     * @maxLength 7
+     * @pattern ^(#[0-9a-fA-F]{6})?$
+     */
+    brand_color?: string;
+    /**
+     * Read-only here. Bind a custom domain through PUT /status-page/domain, which verifies ownership first; a value sent here is ignored
+     * @maxLength 253
+     */
+    custom_domain?: string;
+    /**
+     * The line of free-form text in the page footer. Plain text
+     * @maxLength 500
+     */
+    footer_text?: string;
+    /**
+     * The line shown below the title
+     * @maxLength 255
+     */
+    headline?: string;
+    /** @maxLength 2048 */
+    logo_url?: string;
+    /**
+     * Page title
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /** While false, the public address returns 404. Unpublished by default */
+    published?: boolean;
+    /** Not indexed by default. Once a page has been crawled, switching back does not remove copies already held in third-party indexes */
+    search_engine_index?: boolean;
+    /**
+     * An optional readable address segment under the shared domain. Lowercase letters, digits and hyphens; globally unique. Leave it empty and the page is served at /<project id>, which needs no configuration and cannot be taken by anyone else
+     * @minLength 1
+     * @maxLength 63
+     * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
+     */
+    slug?: string;
+    /** @maxLength 2048 */
+    support_url?: string;
+    theme?: PutStatusPageRequestBodyTheme;
+    /**
+     * IANA name. Empty selects UTC
+     * @maxLength 64
+     */
+    timezone?: string;
+    /**
+     * @minimum 30
+     * @maximum 365
+     */
+    uptime_days?: number;
+    /**
+     * The text shown on the support link. Empty uses the page default. Different products call this different things — help centre, submit a ticket, support
+     * @maxLength 32
+     */
+    support_label?: string;
+}
+/**
+ * Exactly one of the two: `group_id` marks this position as a group, `component_id` as an ungrouped component
+ */
+export interface StatusPageOrderItem {
+    component_id?: string;
+    group_id?: string;
+}
+export interface PutStatusPageOrderRequestBody {
+    items: StatusPageOrderItem[];
+}
+export interface PutStatusPageGroupOrderRequestBody {
+    component_ids: string[];
+}
+export interface StatusPageGroupResource {
+    /** Whether the group is collapsed by default on the page */
+    collapsed: boolean;
+    created_at: string;
+    description: string;
+    group_id: string;
+    name: string;
+    position: number;
+}
+export interface StatusPageGroupListResponseBody {
+    data: StatusPageGroupResource[];
+}
+export interface PutStatusPageGroupRequestBody {
+    collapsed?: boolean;
+    /** @maxLength 2000 */
+    description?: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+}
+export type StatusPageComponentResourceAutoStatusMinSeverity = (typeof StatusPageComponentResourceAutoStatusMinSeverity)[keyof typeof StatusPageComponentResourceAutoStatusMinSeverity];
+export declare const StatusPageComponentResourceAutoStatusMinSeverity: {
+    readonly ANY: "ANY";
+    readonly INFORMATION: "INFORMATION";
+    readonly WARNING: "WARNING";
+    readonly AVERAGE: "AVERAGE";
+    readonly HIGH: "HIGH";
+    readonly DISASTER: "DISASTER";
+};
+/**
+ * The status currently shown to the public. OPERATIONAL means normal
+ */
+export type StatusPageComponentResourceCurrentStatus = (typeof StatusPageComponentResourceCurrentStatus)[keyof typeof StatusPageComponentResourceCurrentStatus];
+export declare const StatusPageComponentResourceCurrentStatus: {
+    readonly OPERATIONAL: "OPERATIONAL";
+    readonly DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+    readonly PARTIAL_OUTAGE: "PARTIAL_OUTAGE";
+    readonly MAJOR_OUTAGE: "MAJOR_OUTAGE";
+    readonly UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+};
+export interface StatusPageComponentResource {
+    auto_status_min_severity: StatusPageComponentResourceAutoStatusMinSeverity;
+    component_id: string;
+    created_at: string;
+    /** The status currently shown to the public. OPERATIONAL means normal */
+    current_status: StatusPageComponentResourceCurrentStatus;
+    description: string;
+    /** Empty means ungrouped, placed directly at the top level of the page */
+    group_id: string;
+    name: string;
+    /** Hide this row while everything is normal */
+    only_show_if_degraded: boolean;
+    position: number;
+    /** Whether the availability bar is shown. Components with this disabled are also excluded from the aggregate of their group */
+    show_uptime: boolean;
+    /** The moment this component started being covered. Earlier days are shown as unmeasured rather than operational */
+    started_on: string;
+    /** Availability over the past `uptime_days` days */
+    uptime_percent: number;
+}
+export interface StatusPageComponentListResponseBody {
+    data: StatusPageComponentResource[];
+}
+/**
+ * Alerts below this severity do not change the status of this row
+ */
+export type PutStatusPageComponentRequestBodyAutoStatusMinSeverity = (typeof PutStatusPageComponentRequestBodyAutoStatusMinSeverity)[keyof typeof PutStatusPageComponentRequestBodyAutoStatusMinSeverity];
+export declare const PutStatusPageComponentRequestBodyAutoStatusMinSeverity: {
+    readonly ANY: "ANY";
+    readonly INFORMATION: "INFORMATION";
+    readonly WARNING: "WARNING";
+    readonly AVERAGE: "AVERAGE";
+    readonly HIGH: "HIGH";
+    readonly DISASTER: "DISASTER";
+};
+export interface PutStatusPageComponentRequestBody {
+    /** Alerts below this severity do not change the status of this row */
+    auto_status_min_severity?: PutStatusPageComponentRequestBodyAutoStatusMinSeverity;
+    /** @maxLength 2000 */
+    description?: string;
+    /** Empty leaves the component ungrouped */
+    group_id?: string;
+    /**
+     * Customer-facing copy; appears verbatim on the public page
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    only_show_if_degraded?: boolean;
+    show_uptime?: boolean;
+    /** Meaningful only at creation and immutable afterwards. Empty selects the current moment */
+    started_on?: string;
+}
+export interface StatusPageComponentSourceServer {
+    server_id: string;
+}
+export interface StatusPageComponentSourceWebCheck {
+    /** Whether the checked address is shown on the public page */
+    show_url?: boolean;
+    web_check_id: string;
+}
+export interface StatusPageComponentSourcesResource {
+    servers: StatusPageComponentSourceServer[];
+    web_checks: StatusPageComponentSourceWebCheck[];
+}
+/**
+ * Submits the complete set; anything not listed is unbound
+ */
+export interface PutStatusPageComponentSourcesRequestBody {
+    servers?: StatusPageComponentSourceServer[];
+    web_checks?: StatusPageComponentSourceWebCheck[];
+}
+export type StatusPageIncidentComponentResourceNewStatus = (typeof StatusPageIncidentComponentResourceNewStatus)[keyof typeof StatusPageIncidentComponentResourceNewStatus];
+export declare const StatusPageIncidentComponentResourceNewStatus: {
+    readonly OPERATIONAL: "OPERATIONAL";
+    readonly DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+    readonly PARTIAL_OUTAGE: "PARTIAL_OUTAGE";
+    readonly MAJOR_OUTAGE: "MAJOR_OUTAGE";
+    readonly UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+};
+export type StatusPageIncidentComponentResourceOldStatus = (typeof StatusPageIncidentComponentResourceOldStatus)[keyof typeof StatusPageIncidentComponentResourceOldStatus];
+export declare const StatusPageIncidentComponentResourceOldStatus: {
+    readonly OPERATIONAL: "OPERATIONAL";
+    readonly DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+    readonly PARTIAL_OUTAGE: "PARTIAL_OUTAGE";
+    readonly MAJOR_OUTAGE: "MAJOR_OUTAGE";
+    readonly UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+};
+/**
+ * A status transition of one component within one update. The component name is a snapshot taken at the time
+ */
+export interface StatusPageIncidentComponentResource {
+    component_id: string;
+    component_name: string;
+    new_status: StatusPageIncidentComponentResourceNewStatus;
+    old_status: StatusPageIncidentComponentResourceOldStatus;
+}
+export type StatusPageIncidentUpdateResourceIncidentStatus = (typeof StatusPageIncidentUpdateResourceIncidentStatus)[keyof typeof StatusPageIncidentUpdateResourceIncidentStatus];
+export declare const StatusPageIncidentUpdateResourceIncidentStatus: {
+    readonly INVESTIGATING: "INVESTIGATING";
+    readonly IDENTIFIED: "IDENTIFIED";
+    readonly MONITORING: "MONITORING";
+    readonly RESOLVED: "RESOLVED";
+};
+export interface StatusPageIncidentUpdateResource {
+    /** @nullable */
+    affected_components: StatusPageIncidentComponentResource[] | null;
+    /** Body text. Plain text */
+    body: string;
+    incident_status: StatusPageIncidentUpdateResourceIncidentStatus;
+    published_at: string;
+    update_id: string;
+}
+export type StatusPageIncidentResourceImpact = (typeof StatusPageIncidentResourceImpact)[keyof typeof StatusPageIncidentResourceImpact];
+export declare const StatusPageIncidentResourceImpact: {
+    readonly NONE: "NONE";
+    readonly MINOR: "MINOR";
+    readonly MAJOR: "MAJOR";
+    readonly CRITICAL: "CRITICAL";
+};
+export type StatusPageIncidentResourceIncidentStatus = (typeof StatusPageIncidentResourceIncidentStatus)[keyof typeof StatusPageIncidentResourceIncidentStatus];
+export declare const StatusPageIncidentResourceIncidentStatus: {
+    readonly INVESTIGATING: "INVESTIGATING";
+    readonly IDENTIFIED: "IDENTIFIED";
+    readonly MONITORING: "MONITORING";
+    readonly RESOLVED: "RESOLVED";
+};
+export interface StatusPageIncidentResource {
+    impact: StatusPageIncidentResourceImpact;
+    incident_id: string;
+    incident_status: StatusPageIncidentResourceIncidentStatus;
+    name: string;
+    published_at: string;
+    /** @nullable */
+    resolved_at: string | null;
+    /** When the incident began, not when the notice was published */
+    started_at: string;
+    /**
+     * Most recently published first
+     * @nullable
+     */
+    updates: StatusPageIncidentUpdateResource[] | null;
+}
+export interface LengthAwarePageStatusPageIncidentResource {
+    data: StatusPageIncidentResource[];
+    limit: number;
+    offset: number;
+    total: number;
+}
+/**
+ * Empty returns this component to operational
+ */
+export type StatusPageIncidentComponentRequestStatus = (typeof StatusPageIncidentComponentRequestStatus)[keyof typeof StatusPageIncidentComponentRequestStatus];
+export declare const StatusPageIncidentComponentRequestStatus: {
+    readonly OPERATIONAL: "OPERATIONAL";
+    readonly DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+    readonly PARTIAL_OUTAGE: "PARTIAL_OUTAGE";
+    readonly MAJOR_OUTAGE: "MAJOR_OUTAGE";
+    readonly UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+};
+export interface StatusPageIncidentComponentRequest {
+    component_id: string;
+    /** Empty returns this component to operational */
+    status?: StatusPageIncidentComponentRequestStatus;
+}
+/**
+ * Empty derives the impact from the affected components
+ */
+export type PublishStatusPageIncidentRequestBodyImpact = (typeof PublishStatusPageIncidentRequestBodyImpact)[keyof typeof PublishStatusPageIncidentRequestBodyImpact];
+export declare const PublishStatusPageIncidentRequestBodyImpact: {
+    readonly NONE: "NONE";
+    readonly MINOR: "MINOR";
+    readonly MAJOR: "MAJOR";
+    readonly CRITICAL: "CRITICAL";
+};
+export type PublishStatusPageIncidentRequestBodyIncidentStatus = (typeof PublishStatusPageIncidentRequestBodyIncidentStatus)[keyof typeof PublishStatusPageIncidentRequestBodyIncidentStatus];
+export declare const PublishStatusPageIncidentRequestBodyIncidentStatus: {
+    readonly INVESTIGATING: "INVESTIGATING";
+    readonly IDENTIFIED: "IDENTIFIED";
+    readonly MONITORING: "MONITORING";
+    readonly RESOLVED: "RESOLVED";
+};
+export interface PublishStatusPageIncidentRequestBody {
+    /**
+     * Body of the first update. Plain text
+     * @minLength 1
+     */
+    body: string;
+    components?: StatusPageIncidentComponentRequest[];
+    /** Empty derives the impact from the affected components */
+    impact?: PublishStatusPageIncidentRequestBodyImpact;
+    incident_status?: PublishStatusPageIncidentRequestBodyIncidentStatus;
+    /**
+     * The public title
+     * @minLength 1
+     * @maxLength 255
+     */
+    name: string;
+    /** Empty selects the current moment. Backfilling a past incident sets it in the past */
+    published_at?: string;
+    /** When the incident began. Empty uses the publication time */
+    started_at?: string;
+}
+/**
+ * Empty keeps the current stage. RESOLVED closes the notice and returns every affected component to operational
+ */
+export type PostStatusPageIncidentUpdateRequestBodyIncidentStatus = (typeof PostStatusPageIncidentUpdateRequestBodyIncidentStatus)[keyof typeof PostStatusPageIncidentUpdateRequestBodyIncidentStatus];
+export declare const PostStatusPageIncidentUpdateRequestBodyIncidentStatus: {
+    readonly INVESTIGATING: "INVESTIGATING";
+    readonly IDENTIFIED: "IDENTIFIED";
+    readonly MONITORING: "MONITORING";
+    readonly RESOLVED: "RESOLVED";
+};
+export interface PostStatusPageIncidentUpdateRequestBody {
+    /**
+     * Body text. Plain text
+     * @minLength 1
+     */
+    body: string;
+    /** Lists only the components being changed by this update; those not listed keep their current status */
+    components?: StatusPageIncidentComponentRequest[];
+    /** Empty keeps the current stage. RESOLVED closes the notice and returns every affected component to operational */
+    incident_status?: PostStatusPageIncidentUpdateRequestBodyIncidentStatus;
+    published_at?: string;
+}
+export type StatusPageMaintenanceComponentResourceComponentStatus = (typeof StatusPageMaintenanceComponentResourceComponentStatus)[keyof typeof StatusPageMaintenanceComponentResourceComponentStatus];
+export declare const StatusPageMaintenanceComponentResourceComponentStatus: {
+    readonly UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+    readonly DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+};
+export interface StatusPageMaintenanceComponentResource {
+    component_id: string;
+    component_name: string;
+    component_status: StatusPageMaintenanceComponentResourceComponentStatus;
+}
+export type StatusPageMaintenanceResourceMaintenanceStatus = (typeof StatusPageMaintenanceResourceMaintenanceStatus)[keyof typeof StatusPageMaintenanceResourceMaintenanceStatus];
+export declare const StatusPageMaintenanceResourceMaintenanceStatus: {
+    readonly SCHEDULED: "SCHEDULED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly COMPLETED: "COMPLETED";
+    readonly CANCELLED: "CANCELLED";
+};
+export interface StatusPageMaintenanceResource {
+    /** @nullable */
+    affected_components: StatusPageMaintenanceComponentResource[] | null;
+    /** Maintenance description. Plain text */
+    body: string;
+    /**
+     * When the maintenance actually finished
+     * @nullable
+     */
+    completed_at: string | null;
+    maintenance_id: string;
+    maintenance_status: StatusPageMaintenanceResourceMaintenanceStatus;
+    name: string;
+    scheduled_for: string;
+    scheduled_until: string;
+    /**
+     * When the maintenance actually started, which may differ from the scheduled time
+     * @nullable
+     */
+    started_at: string | null;
+}
+export interface LengthAwarePageStatusPageMaintenanceResource {
+    data: StatusPageMaintenanceResource[];
+    limit: number;
+    offset: number;
+    total: number;
+}
+/**
+ * How this component is shown while the maintenance runs. Neither value reduces availability
+ */
+export type StatusPageMaintenanceComponentRequestComponentStatus = (typeof StatusPageMaintenanceComponentRequestComponentStatus)[keyof typeof StatusPageMaintenanceComponentRequestComponentStatus];
+export declare const StatusPageMaintenanceComponentRequestComponentStatus: {
+    readonly UNDER_MAINTENANCE: "UNDER_MAINTENANCE";
+    readonly DEGRADED_PERFORMANCE: "DEGRADED_PERFORMANCE";
+};
+export interface StatusPageMaintenanceComponentRequest {
+    component_id: string;
+    /** How this component is shown while the maintenance runs. Neither value reduces availability */
+    component_status?: StatusPageMaintenanceComponentRequestComponentStatus;
+}
+export interface ScheduleStatusPageMaintenanceRequestBody {
+    /**
+     * Maintenance description. Plain text
+     * @minLength 1
+     */
+    body: string;
+    /**
+     * At least one. Maintenance that affects no component reads on the page as an announcement with no subject
+     * @minItems 1
+     */
+    components: StatusPageMaintenanceComponentRequest[];
+    /**
+     * @minLength 1
+     * @maxLength 255
+     */
+    name: string;
+    scheduled_for: string;
+    /** Must be later than `scheduled_for` */
+    scheduled_until: string;
+}
+/**
+ * NONE means no certificate has been requested for this domain yet
+ */
+export type StatusPageDomainResourceCertificateStatus = (typeof StatusPageDomainResourceCertificateStatus)[keyof typeof StatusPageDomainResourceCertificateStatus];
+export declare const StatusPageDomainResourceCertificateStatus: {
+    readonly NONE: "NONE";
+    readonly PENDING: "PENDING";
+    readonly ACTIVE: "ACTIVE";
+    readonly FAILED: "FAILED";
+};
+export interface StatusPageDomainResource {
+    /**
+     * When the current certificate expires
+     * @nullable
+     */
+    certificate_not_after: string | null;
+    /** NONE means no certificate has been requested for this domain yet */
+    certificate_status: StatusPageDomainResourceCertificateStatus;
+    /** The bound custom domain. Empty means none is bound */
+    domain: string;
+    /** The value the domain must point at */
+    expected_cname: string;
+    /** Why the most recent issuance attempt failed. Empty when it did not */
+    last_error: string;
+    /** What the domain currently resolves to. Empty when it resolves to nothing */
+    observed_cname: string;
+    /** The address this page is served at, taking the custom domain into account */
+    public_url: string;
+    /** Whether the domain currently points at the status page */
+    verified: boolean;
+    /**
+     * When ownership was last confirmed
+     * @nullable
+     */
+    verified_at: string | null;
+}
+export interface PutStatusPageDomainRequestBody {
+    /**
+     * Your own domain, such as status.acme.com. It must already point at the status page by CNAME
+     * @minLength 1
+     * @maxLength 253
+     */
+    domain: string;
+}
+/**
+ * Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
+ */
+export interface OffsetPagination {
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+    /** @minimum 0 */
+    total_count?: number;
+}
+/**
+ * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
+ */
+export interface CursorPagination {
+    /** @minimum 1 */
+    page_size: number;
+    /** @nullable */
+    next_cursor?: string | null;
+}
+export type ListIncidentsParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+    /**
+     * Restrict to a single machine
+     */
+    server_id?: string;
+    /**
+     * Restrict to a single web check. Combines with server_id rather than replacing it
+     */
+    web_check_id?: string;
+    incident_status?: ListIncidentsIncidentStatus;
+    /**
+     * Matches at or above this severity, not exactly this severity
+     */
+    min_severity?: ListIncidentsMinSeverity;
+    started_after?: string;
+    started_before?: string;
+    /**
+     * Incidents that **overlap** [active_from, active_to]. This is what you want when overlaying incident bands on a metric chart
+     */
+    active_from?: string;
+    active_to?: string;
+    /**
+     * Given as `key` or `key=value`, repeatable. Multiple tags are combined with AND
+     * @nullable
+     */
+    tag?: string[] | null;
+    assignee_user_id?: string;
+    /**
+     * Whether someone has finished handling it here. Independent of `incident_status`
+     */
+    closed?: ListIncidentsClosed;
+    acknowledged?: ListIncidentsAcknowledged;
+    unassigned?: ListIncidentsUnassigned;
+    /**
+     * @maxLength 255
+     */
+    keyword?: string;
+};
+export type ListIncidentsIncidentStatus = (typeof ListIncidentsIncidentStatus)[keyof typeof ListIncidentsIncidentStatus];
+export declare const ListIncidentsIncidentStatus: {
+    readonly PROBLEM: "PROBLEM";
+    readonly RESOLVED: "RESOLVED";
+};
+export type ListIncidentsMinSeverity = (typeof ListIncidentsMinSeverity)[keyof typeof ListIncidentsMinSeverity];
+export declare const ListIncidentsMinSeverity: {
+    readonly NOT_CLASSIFIED: "NOT_CLASSIFIED";
+    readonly INFORMATION: "INFORMATION";
+    readonly WARNING: "WARNING";
+    readonly AVERAGE: "AVERAGE";
+    readonly HIGH: "HIGH";
+    readonly DISASTER: "DISASTER";
+};
+export type ListIncidentsClosed = (typeof ListIncidentsClosed)[keyof typeof ListIncidentsClosed];
+export declare const ListIncidentsClosed: {
+    readonly true: "true";
+    readonly false: "false";
+};
+export type ListIncidentsAcknowledged = (typeof ListIncidentsAcknowledged)[keyof typeof ListIncidentsAcknowledged];
+export declare const ListIncidentsAcknowledged: {
+    readonly true: "true";
+    readonly false: "false";
+};
+export type ListIncidentsUnassigned = (typeof ListIncidentsUnassigned)[keyof typeof ListIncidentsUnassigned];
+export declare const ListIncidentsUnassigned: {
+    readonly true: "true";
+    readonly false: "false";
+};
+export type ListIncidentTimelineParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * The next_cursor returned by the previous page. Omit it for the first page.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    cursor?: string;
+};
+export type ListServerItemsParams = {
+    /**
+     * Fuzzy match on key or name
+     * @maxLength 255
+     */
+    keyword?: string;
+    /**
+     * Given as `key` or `key=value`, repeatable. The `component` tags applied by the official templates (cpu, memory, filesystem and so on) are filtered through this
+     * @nullable
+     */
+    tag?: string[] | null;
+};
+export type GetServerMetricParams = {
+    /**
+     * **Prefix match**: `vfs.fs.size` returns one series per mount point. Supply this or `item_id`
+     */
+    item_key?: string;
+    item_id?: string;
+    /**
+     * Defaults to one hour ago
+     */
+    from?: string;
+    to?: string;
+    /**
+     * Number of downsampling buckets. 0 returns the collected data points unchanged
+     * @minimum 0
+     */
+    max_points?: number;
+    /**
+     * Also return the thresholds currently in effect for these items
+     */
+    include_thresholds?: boolean;
+};
+export type ListProjectTopItemsParams = {
+    kind: ListProjectTopItemsKind;
+    /**
+     * 0 uses the default
+     * @minimum 0
+     * @maximum 100
+     */
+    limit?: number;
+};
+export type ListProjectTopItemsKind = (typeof ListProjectTopItemsKind)[keyof typeof ListProjectTopItemsKind];
+export declare const ListProjectTopItemsKind: {
+    readonly CPU_UTILIZATION: "CPU_UTILIZATION";
+    readonly MEMORY_UTILIZATION: "MEMORY_UTILIZATION";
+    readonly ROOT_FILESYSTEM_USED: "ROOT_FILESYSTEM_USED";
+};
+export type ListServersParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+    /**
+     * Fuzzy match on name or address
+     * @maxLength 255
+     */
+    keyword?: string;
+    monitoring_status?: ListServersMonitoringStatus;
+};
+export type ListServersMonitoringStatus = (typeof ListServersMonitoringStatus)[keyof typeof ListServersMonitoringStatus];
+export declare const ListServersMonitoringStatus: {
+    readonly PENDING: "PENDING";
+    readonly ACTIVE: "ACTIVE";
+    readonly DISABLED: "DISABLED";
+    readonly FAILED: "FAILED";
+};
+export type ListWebChecksParams = {
+    /**
+     * Restrict to the checks of a single machine. Omit for the whole project
+     */
+    server_id?: string;
+};
+export type GetSliReportParams = {
+    from?: string;
+    to?: string;
+    /**
+     * Return the most recent N complete periods. Use this or from/to, not both
+     * @minimum 0
+     * @maximum 100
+     */
+    periods?: number;
+};
+export type ListStatusPageIncidentsParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+};
+export type ListStatusPageMaintenancesParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+};